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

Last change on this file since 13690 was 13690, checked in by Mark Evenson, 9 years ago

Changes corresponding to abcl-20111102a.pdf.

Now generating LaTeX from docstring via grovel.lisp.

Added index.

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