source: trunk/abcl/doc/manual/java.tex @ 13627

Last change on this file since 13627 was 13627, checked in by Mark Evenson, 10 years ago

Manually wrap text for JAVA docstrings.

File size: 6.5 KB
Line 
1\begin{verbatim}
2%JGET-PROPERTY-VALUE
3  Function: Gets a JavaBeans property on JAVA-OBJECT.
4%JSET-PROPERTY-VALUE
5  Function: Sets a JavaBean property on JAVA-OBJECT.
6*JAVA-OBJECT-TO-STRING-LENGTH*
7  Variable: Length to truncate toString() PRINT-OBJECT output for an
8 otherwise unspecialized JAVA-OBJECT.  Can be set to NIL to indicate
9 no limit.
10+FALSE+
11  Variable: The JVM primitive value for boolean false.
12+NULL+
13  Variable: The JVM null object reference.
14+TRUE+
15  Variable: The JVM primitive value for boolean true.
16ADD-TO-CLASSPATH
17  Generic Function: (not documented)
18CHAIN
19  Macro: (not documented)
20DESCRIBE-JAVA-OBJECT
21  Function: (not documented)
22DUMP-CLASSPATH
23  Function: (not documented)
24ENSURE-JAVA-CLASS
25  Function: (not documented)
26ENSURE-JAVA-OBJECT
27  Function: Ensures OBJ is wrapped in a JAVA-OBJECT, wrapping it if necessary.
28GET-CURRENT-CLASSLOADER
29  Function: (not documented)
30GET-DEFAULT-CLASSLOADER
31  Function: (not documented)
32JARRAY-COMPONENT-TYPE
33  Function: Returns the component type of the array type ATYPE
34JARRAY-LENGTH
35  Function: (not documented)
36JARRAY-REF
37  Function: Dereferences the Java array JAVA-ARRAY using the given
38 INDICIES, coercing the result into a Lisp object, if possible.
39JARRAY-REF-RAW
40  Function: Dereference the Java array JAVA-ARRAY using the given
41 INDICIES. Does not attempt to coerce the result into a Lisp object.
42JARRAY-SET
43  Function: Stores NEW-VALUE at the given index in JAVA-ARRAY.
44JAVA-CLASS
45  Class: (not documented)
46JAVA-EXCEPTION
47  Class: (not documented)
48JAVA-EXCEPTION-CAUSE
49  Function: (not documented)
50JAVA-OBJECT
51  Class: (not documented)
52JAVA-OBJECT-P
53  Function: Returns T if OBJECT is a JAVA-OBJECT.
54JCALL
55  Function: Invokes the Java method METHOD-REF on INSTANCE with
56 arguments ARGS, coercing the result into a Lisp object, if possible.
57JCALL-RAW
58  Function: Invokes the Java method METHOD-REF on INSTANCE with
59 arguments ARGS. Does not attempt to coerce the result into a Lisp
60 object.
61JCLASS
62  Function: Returns a reference to the Java class designated by
63 NAME-OR-CLASS-REF. If the CLASS-LOADER parameter is passed, the class
64 is resolved with respect to the given ClassLoader.
65JCLASS-ARRAY-P
66  Function: Returns T if CLASS is an array class
67JCLASS-CONSTRUCTORS
68  Function: Returns a vector of constructors for CLASS
69JCLASS-FIELD
70  Function: Returns the field named FIELD-NAME of CLASS
71JCLASS-FIELDS
72  Function: Returns a vector of all (or just the declared/public, if
73 DECLARED/PUBLIC is true) fields of CLASS
74JCLASS-INTERFACE-P
75  Function: Returns T if CLASS is an interface
76JCLASS-INTERFACES
77  Function: Returns the vector of interfaces of CLASS
78JCLASS-METHODS
79  Function: Return a vector of all (or just the declared/public, if
80 DECLARED/PUBLIC is true) methods of CLASS
81JCLASS-NAME
82  Function: (not documented)
83JCLASS-OF
84  Function: (not documented)
85JCLASS-SUPERCLASS
86  Function: Returns the superclass of CLASS, or NIL if it hasn't got one
87JCLASS-SUPERCLASS-P
88  Function: Returns T if CLASS-1 is a superclass or interface of CLASS-2
89JCOERCE
90  Function: Attempts to coerce OBJECT into a JavaObject of class
91 INTENDED-CLASS.  Raises a TYPE-ERROR if no conversion is possible.
92JCONSTRUCTOR
93  Function: Returns a reference to the Java constructor of CLASS-REF
94 with the given PARAMETER-CLASS-REFS.
95JCONSTRUCTOR-PARAMS
96  Function: Returns a vector of parameter types (Java classes) for CONSTRUCTOR
97JEQUAL
98  Function: Compares obj1 with obj2 using java.lang.Object.equals()
99JFIELD
100  Function: Retrieves or modifies a field in a Java class or instance.
101JFIELD-NAME
102  Function: Returns the name of FIELD as a Lisp string
103JFIELD-RAW
104  Function: Retrieves or modifies a field in a Java class or instance. Does not
105JFIELD-TYPE
106  Function: Returns the type (Java class) of FIELD
107JINSTANCE-OF-P
108  Function: OBJ is an instance of CLASS (or one of its subclasses)
109JINTERFACE-IMPLEMENTATION
110  Function: Creates and returns an implementation of a Java interface with
111JMAKE-INVOCATION-HANDLER
112  Function: (not documented)
113JMAKE-PROXY
114  Generic Function: (not documented)
115JMEMBER-PROTECTED-P
116  Function: MEMBER is a protected member of its declaring class
117JMEMBER-PUBLIC-P
118  Function: MEMBER is a public member of its declaring class
119JMEMBER-STATIC-P
120  Function: MEMBER is a static member of its declaring class
121JMETHOD
122  Function: Returns a reference to the Java method METHOD-NAME of
123 CLASS-REF with the given PARAMETER-CLASS-REFS.
124JMETHOD-LET
125  Macro: (not documented)
126JMETHOD-NAME
127  Function: Returns the name of METHOD as a Lisp string
128JMETHOD-PARAMS
129  Function: Returns a vector of parameter types (Java classes) for METHOD
130JMETHOD-RETURN-TYPE
131  Function: Returns the result type (Java class) of the METHOD
132JNEW
133  Function: Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
134JNEW-ARRAY
135  Function: Creates a new Java array of type ELEMENT-TYPE, with the given DIMENSIONS.
136JNEW-ARRAY-FROM-ARRAY
137  Function: Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
138JNEW-ARRAY-FROM-LIST
139  Function: (not documented)
140JNEW-RUNTIME-CLASS
141  Function: (not documented)
142JNULL-REF-P
143  Function: Returns a non-NIL value when the JAVA-OBJECT `object` is `null`,
144JOBJECT-CLASS
145  Function: Returns the Java class that OBJ belongs to
146JOBJECT-LISP-VALUE
147  Function: Attempts to coerce JAVA-OBJECT into a Lisp object.
148JPROPERTY-VALUE
149  Function: (not documented)
150JREDEFINE-METHOD
151  Function: (not documented)
152JREGISTER-HANDLER
153  Function: (not documented)
154JRESOLVE-METHOD
155  Function: Finds the most specific Java method METHOD-NAME on
156 INSTANCE applicable to arguments ARGS. Returns NIL if no suitable
157 method is found. The algorithm used for resolution is the same used
158 by JCALL when it is called with a string as the first parameter
159 (METHOD-REF).
160JRUN-EXCEPTION-PROTECTED
161  Function: Invokes the function CLOSURE and returns the result.
162  Signals an error if stack or heap exhaustion occurs.
163JRUNTIME-CLASS-EXISTS-P
164  Function: (not documented)
165JSTATIC
166  Function: Invokes the static method METHOD on class CLASS with ARGS.
167JSTATIC-RAW
168  Function: Invokes the static method METHOD on class CLASS with
169 ARGS. Does not attempt to coerce the arguments or result into a Lisp
170 object.
171MAKE-CLASSLOADER
172  Function: (not documented)
173MAKE-IMMEDIATE-OBJECT
174  Function: Attempts to coerce a given Lisp object into a java-object of the
175REGISTER-JAVA-EXCEPTION
176  Function: Registers the Java Throwable named by the symbol
177 EXCEPTION-NAME as the condition designated by CONDITION-SYMBOL.
178  Returns T if successful, NIL if not.
179UNREGISTER-JAVA-EXCEPTION
180  Function: Unregisters the Java Throwable EXCEPTION-NAME previously
181 registered by REGISTER-JAVA-EXCEPTION.
182\end{verbatim}
Note: See TracBrowser for help on using the repository browser.