doc: adjust JAVA:CHAIN documentation

Re-generate User Manual artifacts.
parent a5b536f7
......@@ -106,15 +106,6 @@ not-documented
not-documented
\end{adjustwidth}
\paragraph{}
\label{EXTENSIONS:*GUI-BACKEND*}
\index{*GUI-BACKEND*}
--- Variable: \textbf{*gui-backend*} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
\label{EXTENSIONS:*INSPECTOR-HOOK*}
\index{*INSPECTOR-HOOK*}
......@@ -501,7 +492,7 @@ Returns all environment variables as an alist containing (name . value)
--- Function: \textbf{init-gui} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
Dummy function used to autoload this file
not-documented
\end{adjustwidth}
\paragraph{}
......@@ -609,7 +600,7 @@ Create and return the pathname of a previously non-existent file.
--- Function: \textbf{make-weak-reference} [\textbf{extensions}] \textit{obj}
\begin{adjustwidth}{5em}{5em}
Creates a weak reference to 'obj'.
not-documented
\end{adjustwidth}
\paragraph{}
......@@ -790,7 +781,7 @@ Returns either the function or NIL if no resolution was possible.
--- Function: \textbf{run-shell-command} [\textbf{extensions}] \textit{command \&key directory (output *standard-output*)}
\begin{adjustwidth}{5em}{5em}
Deprecated. Use SYS:RUN-PROGRAM.
not-documented
\end{adjustwidth}
\paragraph{}
......
......@@ -52,21 +52,24 @@ directory to search for classes or a list of such values.
--- Macro: \textbf{chain} [\textbf{java}] \textit{}
\begin{adjustwidth}{5em}{5em}
Performs chained method invocations. `target' is the receiver
object (when the first call is a virtual method call) or a list in the
form (:static <jclass>) when the first method call is a static method
call. `op' and each of the `ops' are either method designators or lists
in the form (<method designator> \&rest args), where a method designator
is either a string naming a method, or a jmethod object. `chain' will
perform the method call specified by `op' on `target'; then, for each
of the `ops', `chain' will perform the specified method call using the
Performs chained method invocations.
TARGET is either the receiver object when the first call is a virtual method
call or a list in the form (:static <jclass>) when the first method
call is a static method call.
OP and each of the OPS are either method designators or lists in the
form (<method designator> \&rest args), where a method designator is
either a string naming a method, or a jmethod object. CHAIN will
perform the method call specified by OP on TARGET; then, for each
of the OPS, CHAIN will perform the specified method call using the
object returned by the previous method call as the receiver, and will
ultimately return the result of the last method call.
For example, the form:
ultimately return the result of the last method call. For example,
the form:
(chain (:static "java.lang.Runtime") "getRuntime" ("exec" "ls"))
is equivalent to the following Java code:
is equivalent to the following Java code:
java.lang.Runtime.getRuntime().exec("ls");
\end{adjustwidth}
......@@ -343,9 +346,7 @@ When called with one argument, returns the name of the Java class
--- Function: \textbf{jclass-of} [\textbf{java}] \textit{object \&optional name}
\begin{adjustwidth}{5em}{5em}
Returns the name of the Java class of OBJECT. If the NAME argument is
supplied, verifies that OBJECT is an instance of the named class. The name
of the class or nil is always returned as a second value.
not-documented
\end{adjustwidth}
\paragraph{}
......
......@@ -65,7 +65,7 @@ If OBJECT is a symbol it names a dot qualified static FIELD.
\paragraph{}
\label{JSS:HASHMAP-TO-HASHTABLE}
\index{HASHMAP-TO-HASHTABLE}
--- Function: \textbf{hashmap-to-hashtable} [\textbf{jss}] \textit{hashmap \&rest rest \&key (keyfun (function identity)) (valfun (function identity)) (invert? NIL) table \&allow-other-keys}
--- Function: \textbf{hashmap-to-hashtable} [\textbf{jss}] \textit{hashmap \&rest rest \&key (keyfun (function identity)) (valfun (function identity)) (invert? nil) table \&allow-other-keys}
\begin{adjustwidth}{5em}{5em}
Converts the a HASHMAP reference to a java.util.HashMap object to a Lisp hashtable.
......@@ -90,7 +90,7 @@ Push these imports onto the search path. If multiple, earlier in list take prece
\paragraph{}
\label{JSS:INVOKE-RESTARGS}
\index{INVOKE-RESTARGS}
--- Function: \textbf{invoke-restargs} [\textbf{jss}] \textit{method object args \&optional (raw? NIL)}
--- Function: \textbf{invoke-restargs} [\textbf{jss}] \textit{method object args \&optional (raw? nil)}
\begin{adjustwidth}{5em}{5em}
not-documented
......@@ -105,6 +105,15 @@ not-documented
Return the items contained the java.lang.Iterable ITERABLE as a list.
\end{adjustwidth}
\paragraph{}
\label{JSS:J2LIST}
\index{J2LIST}
--- Function: \textbf{j2list} [\textbf{jss}] \textit{thing}
\begin{adjustwidth}{5em}{5em}
Attempt to construct a Lisp list out of a Java THING
\end{adjustwidth}
\paragraph{}
\label{JSS:JAPROPOS}
\index{JAPROPOS}
......@@ -159,10 +168,16 @@ Return a list of interfaces the class implements
\paragraph{}
\label{JSS:JCMN}
\index{JCMN}
--- Function: \textbf{jcmn} [\textbf{jss}] \textit{}
--- Function: \textbf{jcmn} [\textbf{jss}] \textit{class \&optional stream}
\begin{adjustwidth}{5em}{5em}
not-documented
Return a list of the public methods encapsulated by the JVM CLASS.
If STREAM non-nil, output a verbose description to the named output stream.
CLASS may either be a string naming a fully qualified JVM class in dot
notation, or a symbol resolved against all class entries in the
current classpath.
\end{adjustwidth}
\paragraph{}
......@@ -212,7 +227,7 @@ associated is used to look up the static FIELD.
--- Function: \textbf{set-to-list} [\textbf{jss}] \textit{set}
\begin{adjustwidth}{5em}{5em}
not-documented
Convert the java.util.Set named in SET to a Lisp list.
\end{adjustwidth}
\paragraph{}
......
......@@ -1772,10 +1772,11 @@ Returns true if OBJECT is of type logical-pathname; otherwise, returns false.
\paragraph{}
\label{SYSTEM:LOOKUP-KNOWN-SYMBOL}
\index{LOOKUP-KNOWN-SYMBOL}
--- Function: \textbf{lookup-known-symbol} [\textbf{system}] \textit{}
--- Function: \textbf{lookup-known-symbol} [\textbf{system}] \textit{symbol}
\begin{adjustwidth}{5em}{5em}
not-documented
Returns the name of the field and its class designator
which stores the Java object `symbol'.
\end{adjustwidth}
\paragraph{}
......@@ -2429,7 +2430,7 @@ not-documented
--- Function: \textbf{sha256} [\textbf{system}] \textit{\&rest paths-or-strings}
\begin{adjustwidth}{5em}{5em}
Returned ASCIIfied representation of SHA256 digest of byte-based resource at PATHS-OR-STRINGs.
not-documented
\end{adjustwidth}
\paragraph{}
......@@ -2645,8 +2646,7 @@ not-documented
--- Function: \textbf{unzip} [\textbf{system}] \textit{pathname \&optional directory => unzipped\_pathnames}
\begin{adjustwidth}{5em}{5em}
Unpack zip archive at PATHNAME returning a list of extracted pathnames.
If the optional DIRECTORY is specified, root the abstraction in that directory, otherwise use the current value of *DEFAULT-PATHNAME-DEFAULTS*.
not-documented
\end{adjustwidth}
\paragraph{}
......
......@@ -81,7 +81,7 @@ to wake up for retrieval of that object.
\paragraph{}
\label{THREADS:MAKE-MAILBOX}
\index{MAKE-MAILBOX}
--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g283945) NIL)}
--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g284696) nil)}
\begin{adjustwidth}{5em}{5em}
not-documented
......@@ -90,7 +90,7 @@ not-documented
\paragraph{}
\label{THREADS:MAKE-MUTEX}
\index{MAKE-MUTEX}
--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g284205) NIL)}
--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g284956) nil)}
\begin{adjustwidth}{5em}{5em}
not-documented
......
......@@ -396,21 +396,24 @@ calls on the java.util.Enumeration `jenumeration`."
;;; higher-level operators
(defmacro chain (target op &rest ops)
"Performs chained method invocations. `target' is the receiver
object (when the first call is a virtual method call) or a list in the
form (:static <jclass>) when the first method call is a static method
call. `op' and each of the `ops' are either method designators or lists
in the form (<method designator> &rest args), where a method designator
is either a string naming a method, or a jmethod object. `chain' will
perform the method call specified by `op' on `target'; then, for each
of the `ops', `chain' will perform the specified method call using the
"Performs chained method invocations.
TARGET is either the receiver object when the first call is a virtual method
call or a list in the form (:static <jclass>) when the first method
call is a static method call.
OP and each of the OPS are either method designators or lists in the
form (<method designator> &rest args), where a method designator is
either a string naming a method, or a jmethod object. CHAIN will
perform the method call specified by OP on TARGET; then, for each
of the OPS, CHAIN will perform the specified method call using the
object returned by the previous method call as the receiver, and will
ultimately return the result of the last method call.
For example, the form:
ultimately return the result of the last method call. For example,
the form:
(chain (:static \"java.lang.Runtime\") \"getRuntime\" (\"exec\" \"ls\"))
is equivalent to the following Java code:
is equivalent to the following Java code:
java.lang.Runtime.getRuntime().exec(\"ls\");"
(labels ((canonicalize-op (op) (if (listp op) op (list op)))
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment