source: branches/1.2.x/doc/manual/java.tex @ 14513

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

abcl-1.2.0: Maven POM produce "1.2.0" artifacts.

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