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

Last change on this file since 13858 was 13858, checked in by rschlatte, 9 years ago

Manual: fix grovel.lisp, add to Makefile (not run by default)

... also create new versions of generated files.

File size: 23.4 KB
Line 
1\paragraph{}
2\label{JAVA:JAVA-EXCEPTION-CAUSE}
3\index{JAVA-EXCEPTION-CAUSE}
4--- Function: \textbf{java-exception-cause} [\textbf{java}] \textit{java-exception}
5
6\begin{adjustwidth}{5em}{5em}
7not-documented
8\end{adjustwidth}
9
10\paragraph{}
11\label{JAVA:JCLASS-SUPERCLASS-P}
12\index{JCLASS-SUPERCLASS-P}
13--- Function: \textbf{jclass-superclass-p} [\textbf{java}] \textit{class-1 class-2}
14
15\begin{adjustwidth}{5em}{5em}
16Returns T if CLASS-1 is a superclass or interface of CLASS-2
17\end{adjustwidth}
18
19\paragraph{}
20\label{JAVA:JINTERFACE-IMPLEMENTATION}
21\index{JINTERFACE-IMPLEMENTATION}
22--- Function: \textbf{jinterface-implementation} [\textbf{java}] \textit{interface \&rest method-names-and-defs}
23
24\begin{adjustwidth}{5em}{5em}
25Creates and returns an implementation of a Java interface with
26   methods calling Lisp closures as given in METHOD-NAMES-AND-DEFS.
27
28   INTERFACE is either a Java interface or a string naming one.
29
30   METHOD-NAMES-AND-DEFS is an alternating list of method names
31   (strings) and method definitions (closures).
32
33   For missing methods, a dummy implementation is provided that
34   returns nothing or null depending on whether the return type is
35   void or not. This is for convenience only, and a warning is issued
36   for each undefined method.
37\end{adjustwidth}
38
39\paragraph{}
40\label{JAVA:DUMP-CLASSPATH}
41\index{DUMP-CLASSPATH}
42--- Function: \textbf{dump-classpath} [\textbf{java}] \textit{\&optional classloader}
43
44\begin{adjustwidth}{5em}{5em}
45not-documented
46\end{adjustwidth}
47
48\paragraph{}
49\label{JAVA:ENSURE-JAVA-OBJECT}
50\index{ENSURE-JAVA-OBJECT}
51--- Function: \textbf{ensure-java-object} [\textbf{java}] \textit{obj}
52
53\begin{adjustwidth}{5em}{5em}
54Ensures OBJ is wrapped in a JAVA-OBJECT, wrapping it if necessary.
55\end{adjustwidth}
56
57\paragraph{}
58\label{JAVA:JMETHOD-RETURN-TYPE}
59\index{JMETHOD-RETURN-TYPE}
60--- Function: \textbf{jmethod-return-type} [\textbf{java}] \textit{method}
61
62\begin{adjustwidth}{5em}{5em}
63Returns the result type (Java class) of the METHOD
64\end{adjustwidth}
65
66\paragraph{}
67\label{JAVA:JFIELD-NAME}
68\index{JFIELD-NAME}
69--- Function: \textbf{jfield-name} [\textbf{java}] \textit{field}
70
71\begin{adjustwidth}{5em}{5em}
72Returns the name of FIELD as a Lisp string
73\end{adjustwidth}
74
75\paragraph{}
76\label{JAVA:*JAVA-OBJECT-TO-STRING-LENGTH*}
77\index{*JAVA-OBJECT-TO-STRING-LENGTH*}
78--- Variable: \textbf{*java-object-to-string-length*} [\textbf{java}] \textit{}
79
80\begin{adjustwidth}{5em}{5em}
81Length to truncate toString() PRINT-OBJECT output for an otherwise unspecialized JAVA-OBJECT.  Can be set to NIL to indicate no limit.
82\end{adjustwidth}
83
84\paragraph{}
85\label{JAVA:JINSTANCE-OF-P}
86\index{JINSTANCE-OF-P}
87--- Function: \textbf{jinstance-of-p} [\textbf{java}] \textit{obj class}
88
89\begin{adjustwidth}{5em}{5em}
90OBJ is an instance of CLASS (or one of its subclasses)
91\end{adjustwidth}
92
93\paragraph{}
94\label{JAVA:JSTATIC-RAW}
95\index{JSTATIC-RAW}
96--- Function: \textbf{jstatic-raw} [\textbf{java}] \textit{method class \&rest args}
97
98\begin{adjustwidth}{5em}{5em}
99Invokes the static method METHOD on class CLASS with ARGS. Does not attempt to coerce the arguments or result into a Lisp object.
100\end{adjustwidth}
101
102\paragraph{}
103\label{JAVA:DEFINE-JAVA-CLASS}
104\index{DEFINE-JAVA-CLASS}
105--- Macro: \textbf{define-java-class} [\textbf{java}] \textit{}
106
107\begin{adjustwidth}{5em}{5em}
108not-documented
109\end{adjustwidth}
110
111\paragraph{}
112\label{JAVA:JCLASS-OF}
113\index{JCLASS-OF}
114--- Function: \textbf{jclass-of} [\textbf{java}] \textit{object \&optional name}
115
116\begin{adjustwidth}{5em}{5em}
117not-documented
118\end{adjustwidth}
119
120\paragraph{}
121\label{JAVA:JRUN-EXCEPTION-PROTECTED}
122\index{JRUN-EXCEPTION-PROTECTED}
123--- Function: \textbf{jrun-exception-protected} [\textbf{java}] \textit{closure}
124
125\begin{adjustwidth}{5em}{5em}
126Invokes the function CLOSURE and returns the result.  Signals an error if stack or heap exhaustion occurs.
127\end{adjustwidth}
128
129\paragraph{}
130\label{JAVA:JMETHOD-NAME}
131\index{JMETHOD-NAME}
132--- Function: \textbf{jmethod-name} [\textbf{java}] \textit{method}
133
134\begin{adjustwidth}{5em}{5em}
135Returns the name of METHOD as a Lisp string
136\end{adjustwidth}
137
138\paragraph{}
139\label{JAVA:GET-CURRENT-CLASSLOADER}
140\index{GET-CURRENT-CLASSLOADER}
141--- Function: \textbf{get-current-classloader} [\textbf{java}] \textit{}
142
143\begin{adjustwidth}{5em}{5em}
144not-documented
145\end{adjustwidth}
146
147\paragraph{}
148\label{JAVA:JGET-PROPERTY-VALUE}
149\index{JGET-PROPERTY-VALUE}
150--- Function: \textbf{\%jget-property-value} [\textbf{java}] \textit{java-object property-name}
151
152\begin{adjustwidth}{5em}{5em}
153Gets a JavaBeans property on JAVA-OBJECT.
154SYSTEM-INTERNAL: Use jproperty-value instead.
155\end{adjustwidth}
156
157\paragraph{}
158\label{JAVA:JNEW-ARRAY-FROM-LIST}
159\index{JNEW-ARRAY-FROM-LIST}
160--- Function: \textbf{jnew-array-from-list} [\textbf{java}] \textit{element-type list}
161
162\begin{adjustwidth}{5em}{5em}
163not-documented
164\end{adjustwidth}
165
166\paragraph{}
167\label{JAVA:JMETHOD}
168\index{JMETHOD}
169--- Function: \textbf{jmethod} [\textbf{java}] \textit{class-ref method-name \&rest parameter-class-refs}
170
171\begin{adjustwidth}{5em}{5em}
172Returns a reference to the Java method METHOD-NAME of CLASS-REF with the given PARAMETER-CLASS-REFS.
173\end{adjustwidth}
174
175\paragraph{}
176\label{JAVA:GET-DEFAULT-CLASSLOADER}
177\index{GET-DEFAULT-CLASSLOADER}
178--- Function: \textbf{get-default-classloader} [\textbf{java}] \textit{}
179
180\begin{adjustwidth}{5em}{5em}
181not-documented
182\end{adjustwidth}
183
184\paragraph{}
185\label{JAVA:JCLASS-METHODS}
186\index{JCLASS-METHODS}
187--- Function: \textbf{jclass-methods} [\textbf{java}] \textit{class \&key declared public}
188
189\begin{adjustwidth}{5em}{5em}
190Return a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) methods of CLASS
191\end{adjustwidth}
192
193\paragraph{}
194\label{JAVA:REGISTER-JAVA-EXCEPTION}
195\index{REGISTER-JAVA-EXCEPTION}
196--- Function: \textbf{register-java-exception} [\textbf{java}] \textit{exception-name condition-symbol}
197
198\begin{adjustwidth}{5em}{5em}
199Registers the Java Throwable named by the symbol EXCEPTION-NAME as the condition designated by CONDITION-SYMBOL.  Returns T if successful, NIL if not.
200\end{adjustwidth}
201
202\paragraph{}
203\label{JAVA:JCLASS}
204\index{JCLASS}
205--- Function: \textbf{jclass} [\textbf{java}] \textit{name-or-class-ref \&optional class-loader}
206
207\begin{adjustwidth}{5em}{5em}
208Returns 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.
209\end{adjustwidth}
210
211\paragraph{}
212\label{JAVA:JPROPERTY-VALUE}
213\index{JPROPERTY-VALUE}
214--- Function: \textbf{jproperty-value} [\textbf{java}] \textit{obj prop}
215
216\begin{adjustwidth}{5em}{5em}
217not-documented
218\end{adjustwidth}
219
220\paragraph{}
221\label{JAVA:JSET-PROPERTY-VALUE}
222\index{JSET-PROPERTY-VALUE}
223--- Function: \textbf{\%jset-property-value} [\textbf{java}] \textit{java-object property-name value}
224
225\begin{adjustwidth}{5em}{5em}
226Sets a JavaBean property on JAVA-OBJECT.
227SYSTEM-INTERNAL: Use (setf jproperty-value) instead.
228\end{adjustwidth}
229
230\paragraph{}
231\label{JAVA:JFIELD-TYPE}
232\index{JFIELD-TYPE}
233--- Function: \textbf{jfield-type} [\textbf{java}] \textit{field}
234
235\begin{adjustwidth}{5em}{5em}
236Returns the type (Java class) of FIELD
237\end{adjustwidth}
238
239\paragraph{}
240\label{JAVA:JNEW-RUNTIME-CLASS}
241\index{JNEW-RUNTIME-CLASS}
242--- Function: \textbf{jnew-runtime-class} [\textbf{java}] \textit{class-name \&rest args \&key (superclass java.lang.Object) interfaces constructors methods fields (access-flags (quote (public))) annotations}
243
244\begin{adjustwidth}{5em}{5em}
245Creates and loads a Java class with methods calling Lisp closures
246   as given in METHODS.  CLASS-NAME and SUPER-NAME are strings,
247   INTERFACES is a list of strings, CONSTRUCTORS, METHODS and FIELDS are
248   lists of constructor, method and field definitions.
249
250   Constructor definitions - currently NOT supported - are lists of the form
251   (argument-types function \&optional super-invocation-arguments)
252   where argument-types is a list of strings and function is a lisp function of
253   (1+ (length argument-types)) arguments; the instance (`this') is passed in as
254   the last argument. The optional super-invocation-arguments is a list of numbers
255   between 1 and (length argument-types), where the number k stands for the kth argument
256   to the just defined constructor. If present, the constructor of the superclass
257   will be called with the appropriate arguments. E.g., if the constructor definition is
258   (("java.lang.String" "int") \#'(lambda (string i this) ...) (2 1))
259   then the constructor of the superclass with argument types (int, java.lang.String) will
260   be called with the second and first arguments.
261
262   Method definitions are lists of the form
263   (method-name return-type argument-types function \&key modifiers annotations)
264   where method-name is a string, return-type and argument-types are strings or keywords for
265   primitive types (:void, :int, etc.), and function is a Lisp function of minimum arity
266   (1+ (length argument-types)); the instance (`this') is passed in as the first argument.
267
268   Field definitions are lists of the form (field-name type \&key modifiers annotations).
269\end{adjustwidth}
270
271\paragraph{}
272\label{JAVA:JCLASS-CONSTRUCTORS}
273\index{JCLASS-CONSTRUCTORS}
274--- Function: \textbf{jclass-constructors} [\textbf{java}] \textit{class}
275
276\begin{adjustwidth}{5em}{5em}
277Returns a vector of constructors for CLASS
278\end{adjustwidth}
279
280\paragraph{}
281\label{JAVA:JSTATIC}
282\index{JSTATIC}
283--- Function: \textbf{jstatic} [\textbf{java}] \textit{method class \&rest args}
284
285\begin{adjustwidth}{5em}{5em}
286Invokes the static method METHOD on class CLASS with ARGS.
287\end{adjustwidth}
288
289\paragraph{}
290\label{JAVA:JMETHOD-PARAMS}
291\index{JMETHOD-PARAMS}
292--- Function: \textbf{jmethod-params} [\textbf{java}] \textit{method}
293
294\begin{adjustwidth}{5em}{5em}
295Returns a vector of parameter types (Java classes) for METHOD
296\end{adjustwidth}
297
298\paragraph{}
299\label{JAVA:JNEW}
300\index{JNEW}
301--- Function: \textbf{jnew} [\textbf{java}] \textit{constructor \&rest args}
302
303\begin{adjustwidth}{5em}{5em}
304Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
305\end{adjustwidth}
306
307\paragraph{}
308\label{JAVA:JREGISTER-HANDLER}
309\index{JREGISTER-HANDLER}
310--- Function: \textbf{jregister-handler} [\textbf{java}] \textit{object event handler \&key data count}
311
312\begin{adjustwidth}{5em}{5em}
313not-documented
314\end{adjustwidth}
315
316\paragraph{}
317\label{JAVA:JCLASS-SUPERCLASS}
318\index{JCLASS-SUPERCLASS}
319--- Function: \textbf{jclass-superclass} [\textbf{java}] \textit{class}
320
321\begin{adjustwidth}{5em}{5em}
322Returns the superclass of CLASS, or NIL if it hasn't got one
323\end{adjustwidth}
324
325\paragraph{}
326\label{JAVA:JAVA-OBJECT-P}
327\index{JAVA-OBJECT-P}
328--- Function: \textbf{java-object-p} [\textbf{java}] \textit{object}
329
330\begin{adjustwidth}{5em}{5em}
331Returns T if OBJECT is a JAVA-OBJECT.
332\end{adjustwidth}
333
334\paragraph{}
335\label{JAVA:JARRAY-COMPONENT-TYPE}
336\index{JARRAY-COMPONENT-TYPE}
337--- Function: \textbf{jarray-component-type} [\textbf{java}] \textit{atype}
338
339\begin{adjustwidth}{5em}{5em}
340Returns the component type of the array type ATYPE
341\end{adjustwidth}
342
343\paragraph{}
344\label{JAVA:ADD-TO-CLASSPATH}
345\index{ADD-TO-CLASSPATH}
346--- Generic Function: \textbf{add-to-classpath} [\textbf{java}] \textit{}
347
348\begin{adjustwidth}{5em}{5em}
349not-documented
350\end{adjustwidth}
351
352\paragraph{}
353\label{JAVA:UNREGISTER-JAVA-EXCEPTION}
354\index{UNREGISTER-JAVA-EXCEPTION}
355--- Function: \textbf{unregister-java-exception} [\textbf{java}] \textit{exception-name}
356
357\begin{adjustwidth}{5em}{5em}
358Unregisters the Java Throwable EXCEPTION-NAME previously registered by REGISTER-JAVA-EXCEPTION.
359\end{adjustwidth}
360
361\paragraph{}
362\label{JAVA:JOBJECT-LISP-VALUE}
363\index{JOBJECT-LISP-VALUE}
364--- Function: \textbf{jobject-lisp-value} [\textbf{java}] \textit{java-object}
365
366\begin{adjustwidth}{5em}{5em}
367Attempts to coerce JAVA-OBJECT into a Lisp object.
368\end{adjustwidth}
369
370\paragraph{}
371\label{JAVA:JCLASS-NAME}
372\index{JCLASS-NAME}
373--- Function: \textbf{jclass-name} [\textbf{java}] \textit{class-ref \&optional name}
374
375\begin{adjustwidth}{5em}{5em}
376not-documented
377\end{adjustwidth}
378
379\paragraph{}
380\label{JAVA:JMEMBER-PUBLIC-P}
381\index{JMEMBER-PUBLIC-P}
382--- Function: \textbf{jmember-public-p} [\textbf{java}] \textit{member}
383
384\begin{adjustwidth}{5em}{5em}
385MEMBER is a public member of its declaring class
386\end{adjustwidth}
387
388\paragraph{}
389\label{JAVA:+NULL+}
390\index{+NULL+}
391--- Variable: \textbf{+null+} [\textbf{java}] \textit{}
392
393\begin{adjustwidth}{5em}{5em}
394The JVM null object reference.
395\end{adjustwidth}
396
397\paragraph{}
398\label{JAVA:ENSURE-JAVA-CLASS}
399\index{ENSURE-JAVA-CLASS}
400--- Function: \textbf{ensure-java-class} [\textbf{java}] \textit{jclass}
401
402\begin{adjustwidth}{5em}{5em}
403not-documented
404\end{adjustwidth}
405
406\paragraph{}
407\label{JAVA:JAVA-CLASS}
408\index{JAVA-CLASS}
409--- Class: \textbf{java-class} [\textbf{java}] \textit{}
410
411\begin{adjustwidth}{5em}{5em}
412not-documented
413\end{adjustwidth}
414
415\paragraph{}
416\label{JAVA:JMETHOD-LET}
417\index{JMETHOD-LET}
418--- Macro: \textbf{jmethod-let} [\textbf{java}] \textit{}
419
420\begin{adjustwidth}{5em}{5em}
421not-documented
422\end{adjustwidth}
423
424\paragraph{}
425\label{JAVA:JCLASS-ARRAY-P}
426\index{JCLASS-ARRAY-P}
427--- Function: \textbf{jclass-array-p} [\textbf{java}] \textit{class}
428
429\begin{adjustwidth}{5em}{5em}
430Returns T if CLASS is an array class
431\end{adjustwidth}
432
433\paragraph{}
434\label{JAVA:JCALL}
435\index{JCALL}
436--- Function: \textbf{jcall} [\textbf{java}] \textit{method-ref instance \&rest args}
437
438\begin{adjustwidth}{5em}{5em}
439Invokes the Java method METHOD-REF on INSTANCE with arguments ARGS, coercing the result into a Lisp object, if possible.
440\end{adjustwidth}
441
442\paragraph{}
443\label{JAVA:JARRAY-REF-RAW}
444\index{JARRAY-REF-RAW}
445--- Function: \textbf{jarray-ref-raw} [\textbf{java}] \textit{java-array \&rest indices}
446
447\begin{adjustwidth}{5em}{5em}
448Dereference the Java array JAVA-ARRAY using the given INDICIES. Does not attempt to coerce the result into a Lisp object.
449\end{adjustwidth}
450
451\paragraph{}
452\label{JAVA:JEQUAL}
453\index{JEQUAL}
454--- Function: \textbf{jequal} [\textbf{java}] \textit{obj1 obj2}
455
456\begin{adjustwidth}{5em}{5em}
457Compares obj1 with obj2 using java.lang.Object.equals()
458\end{adjustwidth}
459
460\paragraph{}
461\label{JAVA:JNULL-REF-P}
462\index{JNULL-REF-P}
463--- Function: \textbf{jnull-ref-p} [\textbf{java}] \textit{object}
464
465\begin{adjustwidth}{5em}{5em}
466Returns a non-NIL value when the JAVA-OBJECT `object` is `null`,
467or signals a TYPE-ERROR condition if the object isn't of
468the right type.
469\end{adjustwidth}
470
471\paragraph{}
472\label{JAVA:JNEW-ARRAY}
473\index{JNEW-ARRAY}
474--- Function: \textbf{jnew-array} [\textbf{java}] \textit{element-type \&rest dimensions}
475
476\begin{adjustwidth}{5em}{5em}
477Creates a new Java array of type ELEMENT-TYPE, with the given DIMENSIONS.
478\end{adjustwidth}
479
480\paragraph{}
481\label{JAVA:CHAIN}
482\index{CHAIN}
483--- Macro: \textbf{chain} [\textbf{java}] \textit{}
484
485\begin{adjustwidth}{5em}{5em}
486not-documented
487\end{adjustwidth}
488
489\paragraph{}
490\label{JAVA:JFIELD}
491\index{JFIELD}
492--- Function: \textbf{jfield} [\textbf{java}] \textit{class-ref-or-field field-or-instance \&optional instance value}
493
494\begin{adjustwidth}{5em}{5em}
495Retrieves or modifies a field in a Java class or instance.
496
497Supported argument patterns:
498
499   Case 1: class-ref  field-name:
500      Retrieves the value of a static field.
501
502   Case 2: class-ref  field-name  instance-ref:
503      Retrieves the value of a class field of the instance.
504
505   Case 3: class-ref  field-name  primitive-value:
506      Stores a primitive-value in a static field.
507
508   Case 4: class-ref  field-name  instance-ref  value:
509      Stores value in a class field of the instance.
510
511   Case 5: class-ref  field-name  nil  value:
512      Stores value in a static field (when value may be
513      confused with an instance-ref).
514
515   Case 6: field-name  instance:
516      Retrieves the value of a field of the instance. The
517      class is derived from the instance.
518
519   Case 7: field-name  instance  value:
520      Stores value in a field of the instance. The class is
521      derived from the instance.
522
523
524\end{adjustwidth}
525
526\paragraph{}
527\label{JAVA:JAVA-OBJECT}
528\index{JAVA-OBJECT}
529--- Class: \textbf{java-object} [\textbf{java}] \textit{}
530
531\begin{adjustwidth}{5em}{5em}
532not-documented
533\end{adjustwidth}
534
535\paragraph{}
536\label{JAVA:JCLASS-INTERFACES}
537\index{JCLASS-INTERFACES}
538--- Function: \textbf{jclass-interfaces} [\textbf{java}] \textit{class}
539
540\begin{adjustwidth}{5em}{5em}
541Returns the vector of interfaces of CLASS
542\end{adjustwidth}
543
544\paragraph{}
545\label{JAVA:+TRUE+}
546\index{+TRUE+}
547--- Variable: \textbf{+true+} [\textbf{java}] \textit{}
548
549\begin{adjustwidth}{5em}{5em}
550The JVM primitive value for boolean true.
551\end{adjustwidth}
552
553\paragraph{}
554\label{JAVA:JMAKE-INVOCATION-HANDLER}
555\index{JMAKE-INVOCATION-HANDLER}
556--- Function: \textbf{jmake-invocation-handler} [\textbf{java}] \textit{function}
557
558\begin{adjustwidth}{5em}{5em}
559not-documented
560\end{adjustwidth}
561
562\paragraph{}
563\label{JAVA:JRESOLVE-METHOD}
564\index{JRESOLVE-METHOD}
565--- Function: \textbf{jresolve-method} [\textbf{java}] \textit{method-name instance \&rest args}
566
567\begin{adjustwidth}{5em}{5em}
568Finds 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).
569\end{adjustwidth}
570
571\paragraph{}
572\label{JAVA:MAKE-CLASSLOADER}
573\index{MAKE-CLASSLOADER}
574--- Function: \textbf{make-classloader} [\textbf{java}] \textit{\&optional parent}
575
576\begin{adjustwidth}{5em}{5em}
577not-documented
578\end{adjustwidth}
579
580\paragraph{}
581\label{JAVA:JMEMBER-PROTECTED-P}
582\index{JMEMBER-PROTECTED-P}
583--- Function: \textbf{jmember-protected-p} [\textbf{java}] \textit{member}
584
585\begin{adjustwidth}{5em}{5em}
586MEMBER is a protected member of its declaring class
587\end{adjustwidth}
588
589\paragraph{}
590\label{JAVA:MAKE-IMMEDIATE-OBJECT}
591\index{MAKE-IMMEDIATE-OBJECT}
592--- Function: \textbf{make-immediate-object} [\textbf{java}] \textit{object \&optional type}
593
594\begin{adjustwidth}{5em}{5em}
595Attempts to coerce a given Lisp object into a java-object of the
596given type.  If type is not provided, works as jobject-lisp-value.
597Currently, type may be :BOOLEAN, treating the object as a truth value,
598or :REF, which returns Java null if NIL is provided.
599
600Deprecated.  Please use JAVA:+NULL+, JAVA:+TRUE+, and JAVA:+FALSE+ for
601constructing wrapped primitive types, JAVA:JOBJECT-LISP-VALUE for converting a
602JAVA:JAVA-OBJECT to a Lisp value, or JAVA:JNULL-REF-P to distinguish a wrapped
603null JAVA-OBJECT from NIL.
604\end{adjustwidth}
605
606\paragraph{}
607\label{JAVA:JNEW-ARRAY-FROM-ARRAY}
608\index{JNEW-ARRAY-FROM-ARRAY}
609--- Function: \textbf{jnew-array-from-array} [\textbf{java}] \textit{element-type array}
610
611\begin{adjustwidth}{5em}{5em}
612Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
613   initialized from ARRAY
614\end{adjustwidth}
615
616\paragraph{}
617\label{JAVA:JOBJECT-CLASS}
618\index{JOBJECT-CLASS}
619--- Function: \textbf{jobject-class} [\textbf{java}] \textit{obj}
620
621\begin{adjustwidth}{5em}{5em}
622Returns the Java class that OBJ belongs to
623\end{adjustwidth}
624
625\paragraph{}
626\label{JAVA:JCLASS-FIELDS}
627\index{JCLASS-FIELDS}
628--- Function: \textbf{jclass-fields} [\textbf{java}] \textit{class \&key declared public}
629
630\begin{adjustwidth}{5em}{5em}
631Returns a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) fields of CLASS
632\end{adjustwidth}
633
634\paragraph{}
635\label{JAVA:JAVA-EXCEPTION}
636\index{JAVA-EXCEPTION}
637--- Class: \textbf{java-exception} [\textbf{java}] \textit{}
638
639\begin{adjustwidth}{5em}{5em}
640not-documented
641\end{adjustwidth}
642
643\paragraph{}
644\label{JAVA:DESCRIBE-JAVA-OBJECT}
645\index{DESCRIBE-JAVA-OBJECT}
646--- Function: \textbf{describe-java-object} [\textbf{java}] \textit{}
647
648\begin{adjustwidth}{5em}{5em}
649not-documented
650\end{adjustwidth}
651
652\paragraph{}
653\label{JAVA:JFIELD-RAW}
654\index{JFIELD-RAW}
655--- Function: \textbf{jfield-raw} [\textbf{java}] \textit{class-ref-or-field field-or-instance \&optional instance value}
656
657\begin{adjustwidth}{5em}{5em}
658Retrieves or modifies a field in a Java class or instance. Does not
659attempt to coerce its value or the result into a Lisp object.
660
661Supported argument patterns:
662
663   Case 1: class-ref  field-name:
664      Retrieves the value of a static field.
665
666   Case 2: class-ref  field-name  instance-ref:
667      Retrieves the value of a class field of the instance.
668
669   Case 3: class-ref  field-name  primitive-value:
670      Stores a primitive-value in a static field.
671
672   Case 4: class-ref  field-name  instance-ref  value:
673      Stores value in a class field of the instance.
674
675   Case 5: class-ref  field-name  nil  value:
676      Stores value in a static field (when value may be
677      confused with an instance-ref).
678
679   Case 6: field-name  instance:
680      Retrieves the value of a field of the instance. The
681      class is derived from the instance.
682
683   Case 7: field-name  instance  value:
684      Stores value in a field of the instance. The class is
685      derived from the instance.
686
687
688\end{adjustwidth}
689
690\paragraph{}
691\label{JAVA:JCONSTRUCTOR-PARAMS}
692\index{JCONSTRUCTOR-PARAMS}
693--- Function: \textbf{jconstructor-params} [\textbf{java}] \textit{constructor}
694
695\begin{adjustwidth}{5em}{5em}
696Returns a vector of parameter types (Java classes) for CONSTRUCTOR
697\end{adjustwidth}
698
699\paragraph{}
700\label{JAVA:JMEMBER-STATIC-P}
701\index{JMEMBER-STATIC-P}
702--- Function: \textbf{jmember-static-p} [\textbf{java}] \textit{member}
703
704\begin{adjustwidth}{5em}{5em}
705MEMBER is a static member of its declaring class
706\end{adjustwidth}
707
708\paragraph{}
709\label{JAVA:JCOERCE}
710\index{JCOERCE}
711--- Function: \textbf{jcoerce} [\textbf{java}] \textit{object intended-class}
712
713\begin{adjustwidth}{5em}{5em}
714Attempts to coerce OBJECT into a JavaObject of class INTENDED-CLASS.  Raises a TYPE-ERROR if no conversion is possible.
715\end{adjustwidth}
716
717\paragraph{}
718\label{JAVA:JCONSTRUCTOR}
719\index{JCONSTRUCTOR}
720--- Function: \textbf{jconstructor} [\textbf{java}] \textit{class-ref \&rest parameter-class-refs}
721
722\begin{adjustwidth}{5em}{5em}
723Returns a reference to the Java constructor of CLASS-REF with the given PARAMETER-CLASS-REFS.
724\end{adjustwidth}
725
726\paragraph{}
727\label{JAVA:JARRAY-SET}
728\index{JARRAY-SET}
729--- Function: \textbf{jarray-set} [\textbf{java}] \textit{java-array new-value \&rest indices}
730
731\begin{adjustwidth}{5em}{5em}
732Stores NEW-VALUE at the given index in JAVA-ARRAY.
733\end{adjustwidth}
734
735\paragraph{}
736\label{JAVA:JARRAY-LENGTH}
737\index{JARRAY-LENGTH}
738--- Function: \textbf{jarray-length} [\textbf{java}] \textit{java-array}
739
740\begin{adjustwidth}{5em}{5em}
741not-documented
742\end{adjustwidth}
743
744\paragraph{}
745\label{JAVA:JARRAY-REF}
746\index{JARRAY-REF}
747--- Function: \textbf{jarray-ref} [\textbf{java}] \textit{java-array \&rest indices}
748
749\begin{adjustwidth}{5em}{5em}
750Dereferences the Java array JAVA-ARRAY using the given INDICIES, coercing the result into a Lisp object, if possible.
751\end{adjustwidth}
752
753\paragraph{}
754\label{JAVA:JCLASS-FIELD}
755\index{JCLASS-FIELD}
756--- Function: \textbf{jclass-field} [\textbf{java}] \textit{class field-name}
757
758\begin{adjustwidth}{5em}{5em}
759Returns the field named FIELD-NAME of CLASS
760\end{adjustwidth}
761
762\paragraph{}
763\label{JAVA:JMAKE-PROXY}
764\index{JMAKE-PROXY}
765--- Generic Function: \textbf{jmake-proxy} [\textbf{java}] \textit{}
766
767\begin{adjustwidth}{5em}{5em}
768not-documented
769\end{adjustwidth}
770
771\paragraph{}
772\label{JAVA:JCALL-RAW}
773\index{JCALL-RAW}
774--- Function: \textbf{jcall-raw} [\textbf{java}] \textit{method-ref instance \&rest args}
775
776\begin{adjustwidth}{5em}{5em}
777Invokes the Java method METHOD-REF on INSTANCE with arguments ARGS. Does not attempt to coerce the result into a Lisp object.
778\end{adjustwidth}
779
780\paragraph{}
781\label{JAVA:+FALSE+}
782\index{+FALSE+}
783--- Variable: \textbf{+false+} [\textbf{java}] \textit{}
784
785\begin{adjustwidth}{5em}{5em}
786The JVM primitive value for boolean false.
787\end{adjustwidth}
788
789\paragraph{}
790\label{JAVA:JCLASS-INTERFACE-P}
791\index{JCLASS-INTERFACE-P}
792--- Function: \textbf{jclass-interface-p} [\textbf{java}] \textit{class}
793
794\begin{adjustwidth}{5em}{5em}
795Returns T if CLASS is an interface
796\end{adjustwidth}
797
Note: See TracBrowser for help on using the repository browser.