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

Last change on this file since 13614 was 13614, checked in by Mark Evenson, 11 years ago

Render documentation for variables: Java null, true, and false literal constants.

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 otherwise unspecialized JAVA-OBJECT.  Can be set to NIL to indicate no limit.
8+FALSE+
9  Variable: The JVM primitive value for boolean false.
10+NULL+
11  Variable: The JVM null object reference.
12+TRUE+
13  Variable: The JVM primitive value for boolean true.
15  Generic Function: (not documented)
16CHAIN
17  Macro: (not documented)
18DESCRIBE-JAVA-OBJECT
19  Function: (not documented)
20DUMP-CLASSPATH
21  Function: (not documented)
22ENSURE-JAVA-CLASS
23  Function: (not documented)
24ENSURE-JAVA-OBJECT
25  Function: Ensures OBJ is wrapped in a JAVA-OBJECT, wrapping it if necessary.
27  Function: (not documented)
29  Function: (not documented)
30JARRAY-COMPONENT-TYPE
31  Function: Returns the component type of the array type ATYPE
32JARRAY-LENGTH
33  Function: (not documented)
34JARRAY-REF
35  Function: Dereferences the Java array JAVA-ARRAY using the given INDICIES, coercing the result into a Lisp object, if possible.
36JARRAY-REF-RAW
37  Function: Dereference the Java array JAVA-ARRAY using the given INDICIES. Does not attempt to coerce the result into a Lisp object.
38JARRAY-SET
39  Function: Stores NEW-VALUE at the given index in JAVA-ARRAY.
40JAVA-CLASS
41  Class: (not documented)
42JAVA-EXCEPTION
43  Class: (not documented)
44JAVA-EXCEPTION-CAUSE
45  Function: (not documented)
46JAVA-OBJECT
47  Class: (not documented)
48JAVA-OBJECT-P
49  Function: Returns T if OBJECT is a JAVA-OBJECT.
50JCALL
51  Function: Invokes the Java method METHOD-REF on INSTANCE with arguments ARGS, coercing the result into a Lisp object, if possible.
52JCALL-RAW
53  Function: Invokes the Java method METHOD-REF on INSTANCE with arguments ARGS. Does not attempt to coerce the result into a Lisp object.
54JCLASS
55  Function: Returns a reference to the Java class designated by NAME-OR-CLASS-REF. If the CLASS-LOADER parameter is passed, the class is resolved with respect to the given ClassLoader.
56JCLASS-ARRAY-P
57  Function: Returns T if CLASS is an array class
58JCLASS-CONSTRUCTORS
59  Function: Returns a vector of constructors for CLASS
60JCLASS-FIELD
61  Function: Returns the field named FIELD-NAME of CLASS
62JCLASS-FIELDS
63  Function: Returns a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) fields of CLASS
64JCLASS-INTERFACE-P
65  Function: Returns T if CLASS is an interface
66JCLASS-INTERFACES
67  Function: Returns the vector of interfaces of CLASS
68JCLASS-METHODS
69  Function: Return a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) methods of CLASS
70JCLASS-NAME
71  Function: (not documented)
72JCLASS-OF
73  Function: (not documented)
74JCLASS-SUPERCLASS
75  Function: Returns the superclass of CLASS, or NIL if it hasn't got one
76JCLASS-SUPERCLASS-P
77  Function: Returns T if CLASS-1 is a superclass or interface of CLASS-2
78JCOERCE
79  Function: Attempts to coerce OBJECT into a JavaObject of class INTENDED-CLASS.  Raises a TYPE-ERROR if no conversion is possible.
80JCONSTRUCTOR
81  Function: Returns a reference to the Java constructor of CLASS-REF with the given PARAMETER-CLASS-REFS.
82JCONSTRUCTOR-PARAMS
83  Function: Returns a vector of parameter types (Java classes) for CONSTRUCTOR
84JEQUAL
85  Function: Compares obj1 with obj2 using java.lang.Object.equals()
86JFIELD
87  Function: Retrieves or modifies a field in a Java class or instance.
88JFIELD-NAME
89  Function: Returns the name of FIELD as a Lisp string
90JFIELD-RAW
91  Function: Retrieves or modifies a field in a Java class or instance. Does not
92JFIELD-TYPE
93  Function: Returns the type (Java class) of FIELD
94JINSTANCE-OF-P
95  Function: OBJ is an instance of CLASS (or one of its subclasses)
96JINTERFACE-IMPLEMENTATION
97  Function: Creates and returns an implementation of a Java interface with
98JMAKE-INVOCATION-HANDLER
99  Function: (not documented)
100JMAKE-PROXY
101  Generic Function: (not documented)
102JMEMBER-PROTECTED-P
103  Function: MEMBER is a protected member of its declaring class
104JMEMBER-PUBLIC-P
105  Function: MEMBER is a public member of its declaring class
106JMEMBER-STATIC-P
107  Function: MEMBER is a static member of its declaring class
108JMETHOD
109  Function: Returns a reference to the Java method METHOD-NAME of CLASS-REF with the given PARAMETER-CLASS-REFS.
110JMETHOD-LET
111  Macro: (not documented)
112JMETHOD-NAME
113  Function: Returns the name of METHOD as a Lisp string
114JMETHOD-PARAMS
115  Function: Returns a vector of parameter types (Java classes) for METHOD
116JMETHOD-RETURN-TYPE
117  Function: Returns the result type (Java class) of the METHOD
118JNEW
119  Function: Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
120JNEW-ARRAY
121  Function: Creates a new Java array of type ELEMENT-TYPE, with the given DIMENSIONS.
122JNEW-ARRAY-FROM-ARRAY
123  Function: Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
124JNEW-ARRAY-FROM-LIST
125  Function: (not documented)
126JNEW-RUNTIME-CLASS
127  Function: (not documented)
128JNULL-REF-P
129  Function: Returns a non-NIL value when the JAVA-OBJECT object is null,
130JOBJECT-CLASS
131  Function: Returns the Java class that OBJ belongs to
132JOBJECT-LISP-VALUE
133  Function: Attempts to coerce JAVA-OBJECT into a Lisp object.
134JPROPERTY-VALUE
135  Function: (not documented)
136JREDEFINE-METHOD
137  Function: (not documented)
138JREGISTER-HANDLER
139  Function: (not documented)
140JRESOLVE-METHOD
141  Function: Finds the most specific Java method METHOD-NAME on INSTANCE applicable to arguments ARGS. Returns NIL if no suitable method is found. The algorithm used for resolution is the same used by JCALL when it is called with a string as the first parameter (METHOD-REF).
142JRUN-EXCEPTION-PROTECTED
143  Function: Invokes the function CLOSURE and returns the result.  Signals an error if stack or heap exhaustion occurs.
144JRUNTIME-CLASS-EXISTS-P
145  Function: (not documented)
146JSTATIC
147  Function: Invokes the static method METHOD on class CLASS with ARGS.
148JSTATIC-RAW
149  Function: Invokes the static method METHOD on class CLASS with ARGS. Does not attempt to coerce the arguments or result into a Lisp object.