Changes between Version 4 and Version 5 of JavaFfi

Timestamp:

11/04/10 21:17:12 (13 years ago)

Author:

astalla

Comment:

--

JavaFfi

@@ -9 +9 @@
 The core API is based on Java reflection. Some operators come in two flavors: a concise one that leaves some things to be computed by ABCL at runtime, and a more efficient and verbose one, which is mostly a direct translation of the Java reflection API.
 
+=== Definitions ===
+
+  * ''Java class designator'': either a string denoting the fully qualified name of a Java class, such as "java.lang.String", or a Java class metaobject, that is, an instance of java.lang.Class, for example as returned by the function `jclass`.
+  * ''Java method designator'': in the context of Java method invocations, either a Java method metaobject (an instance of java.lang.reflect.Method), or a string representing the name of the method, for example "toString".
+
 === Function JCALL, JCALL-RAW ===
 
 '''Syntax:'''
 
-'''jcall''' ''method instance &rest args => T''
-
-'''jcall-raw''' ''method instance &rest args => T''
+'''jcall''' ''method instance &rest args => object''
+
+'''jcall-raw''' ''method instance &rest args => a JAVA-OBJECT''
 
 '''Arguments and Values:'''
@@ -44 +49 @@
 '''Syntax:'''
 
-'''jclass''' ''name-or-class-ref &optional class-loader => Java class metaobject''
+'''jclass''' ''name-or-class-ref &optional class-loader => a Java class metaobject''
 
 '''Arguments and Values:'''
 
-`name-or-class-ref` -- a Java class designator, that is, a Java class metaobject (an instance of java.lang.Class), or a string representing the fully qualified name of the Java class, for example "java.lang.Object".
+`name-or-class-ref` -- a Java class designator (see [#Definitions Definitions]).
 
 `class-loader` -- the classloader to use to resolve the class. Refer to the section Class resolution and loading.
@@ -59 +64 @@
 
 `(jclass "java.util.LinkedList") => #<java.lang.Class class java.util.LinkedList {11B50A1}>`
+
+=== Function JSTATIC, JSTATIC-RAW ===
+
+'''Syntax:'''
+
+'''jstatic''' ''method class &rest args => object''
+
+'''jstatic-raw''' ''method class &rest args => JAVA-OBJECT''
+
+'''Arguments and Values:'''
+
+`method` -- a Java method designator.
+
+`class` -- a Java class metaobject.
+
+`args` -- the arguments passed to the method.
+
+'''Description:'''
+
+Reflectively calls a static method and returns the result of the call. `(jstatic method class args)` is equivalent to `(jcall (jmethod class method) nil args)` when `method` is a string, and to `(jcall method nil args)` when `method` is a Java method metaobject (class is thus ignored in that case). Similarly for the `-raw` variants.
+
+`jstatic` translates the result to a Lisp object if possible. `jstatic-raw` performs no translation and always returns the original Java object.
+
+'''Examples:'''
+
+{{{
+(jstatic "getRuntime" "java.lang.Runtime") => #<java.lang.Runtime java.lang.Runtime@1ef3212 {C07527}>
+(jstatic-raw "getRuntime" "java.lang.Runtime") => #<java.lang.Runtime java.lang.Runtime@1ef3212 {156D7C8}>
+(jstatic "getRuntime" (jclass "java.lang.Runtime")) => #<java.lang.Runtime java.lang.Runtime@1ef3212 {C8E4DE}>
+(jstatic (jmethod "java.lang.Runtime" "getRuntime") nil) => #<java.lang.Runtime java.lang.Runtime@1ef3212 {129DF8A}>
+}}}
 
 == Class resolution and loading ==