source: tags/1.5.0/doc/manual/jss.tex

Last change on this file was 15045, checked in by Mark Evenson, 7 years ago

Regenerate TeX sources

(Olof-Joachim Frahm)

From <https://github.com/armedbear/abcl/pull/46/commits/1ce2e96bd9adf0bc305e08e863e361abe327b170>.

Merges <https://github.com/armedbear/abcl/pull/46>.

File size: 7.5 KB
Line 
1\paragraph{}
2\label{JSS:*CL-USER-COMPATIBILITY*}
3\index{*CL-USER-COMPATIBILITY*}
4--- Variable: \textbf{*cl-user-compatibility*} [\textbf{jss}] \textit{}
5
6\begin{adjustwidth}{5em}{5em}
7Whether backwards compatibility with JSS's use of CL-USER has been enabled.
8\end{adjustwidth}
9
10\paragraph{}
11\label{JSS:*DO-AUTO-IMPORTS*}
12\index{*DO-AUTO-IMPORTS*}
13--- Variable: \textbf{*do-auto-imports*} [\textbf{jss}] \textit{}
14
15\begin{adjustwidth}{5em}{5em}
16Whether to automatically introspect all Java classes on the classpath when JSS is loaded.
17\end{adjustwidth}
18
19\paragraph{}
20\label{JSS:CLASSFILES-IMPORT}
21\index{CLASSFILES-IMPORT}
22--- Function: \textbf{classfiles-import} [\textbf{jss}] \textit{directory}
23
24\begin{adjustwidth}{5em}{5em}
25Load all Java classes recursively contained under DIRECTORY in the current process.
26\end{adjustwidth}
27
28\paragraph{}
29\label{JSS:ENSURE-COMPATIBILITY}
30\index{ENSURE-COMPATIBILITY}
31--- Function: \textbf{ensure-compatibility} [\textbf{jss}] \textit{}
32
33\begin{adjustwidth}{5em}{5em}
34Ensure backwards compatibility with JSS's use of CL-USER.
35\end{adjustwidth}
36
37\paragraph{}
38\label{JSS:FIND-JAVA-CLASS}
39\index{FIND-JAVA-CLASS}
40--- Function: \textbf{find-java-class} [\textbf{jss}] \textit{name}
41
42\begin{adjustwidth}{5em}{5em}
43not-documented
44\end{adjustwidth}
45
46\paragraph{}
47\label{JSS:GET-JAVA-FIELD}
48\index{GET-JAVA-FIELD}
49--- Function: \textbf{get-java-field} [\textbf{jss}] \textit{object field \&optional (try-harder *running-in-osgi*)}
50
51\begin{adjustwidth}{5em}{5em}
52Get the value of the FIELD contained in OBJECT.
53If OBJECT is a symbol it names a dot qualified static FIELD.
54\end{adjustwidth}
55
56\paragraph{}
57\label{JSS:HASHMAP-TO-HASHTABLE}
58\index{HASHMAP-TO-HASHTABLE}
59--- Function: \textbf{hashmap-to-hashtable} [\textbf{jss}] \textit{hashmap \&rest rest \&key (keyfun (function identity)) (valfun (function identity)) (invert? NIL) table \&allow-other-keys}
60
61\begin{adjustwidth}{5em}{5em}
62Converts the a HASHMAP reference to a java.util.HashMap object to a Lisp hashtable.
63
64The REST paramter specifies arguments to the underlying MAKE-HASH-TABLE call.
65
66KEYFUN and VALFUN specifies functions to be run on the keys and values
67of the HASHMAP right before they are placed in the hashtable.
68
69If INVERT? is non-nil than reverse the keys and values in the resulting hashtable.
70\end{adjustwidth}
71
72\paragraph{}
73\label{JSS:INVOKE-ADD-IMPORTS}
74\index{INVOKE-ADD-IMPORTS}
75--- Macro: \textbf{invoke-add-imports} [\textbf{jss}] \textit{}
76
77\begin{adjustwidth}{5em}{5em}
78Push these imports onto the search path. If multiple, earlier in list take precedence
79\end{adjustwidth}
80
81\paragraph{}
82\label{JSS:INVOKE-RESTARGS}
83\index{INVOKE-RESTARGS}
84--- Function: \textbf{invoke-restargs} [\textbf{jss}] \textit{method object args \&optional (raw? NIL)}
85
86\begin{adjustwidth}{5em}{5em}
87not-documented
88\end{adjustwidth}
89
90\paragraph{}
91\label{JSS:ITERABLE-TO-LIST}
92\index{ITERABLE-TO-LIST}
93--- Function: \textbf{iterable-to-list} [\textbf{jss}] \textit{iterable}
94
95\begin{adjustwidth}{5em}{5em}
96Return the items contained the java.lang.Iterable ITERABLE as a list.
97\end{adjustwidth}
98
99\paragraph{}
100\label{JSS:J2LIST}
101\index{J2LIST}
102--- Function: \textbf{j2list} [\textbf{jss}] \textit{thing}
103
104\begin{adjustwidth}{5em}{5em}
105Attempt to construct a Lisp list out of a Java THING
106\end{adjustwidth}
107
108\paragraph{}
109\label{JSS:JAPROPOS}
110\index{JAPROPOS}
111--- Function: \textbf{japropos} [\textbf{jss}] \textit{string}
112
113\begin{adjustwidth}{5em}{5em}
114Output the names of all Java class names loaded in the current process which match STRING..
115\end{adjustwidth}
116
117\paragraph{}
118\label{JSS:JAR-IMPORT}
119\index{JAR-IMPORT}
120--- Function: \textbf{jar-import} [\textbf{jss}] \textit{file}
121
122\begin{adjustwidth}{5em}{5em}
123Import all the Java classes contained in the pathname FILE into the JSS dynamic lookup cache.
124\end{adjustwidth}
125
126\paragraph{}
127\label{JSS:JARRAY-TO-LIST}
128\index{JARRAY-TO-LIST}
129--- Function: \textbf{jarray-to-list} [\textbf{jss}] \textit{jarray}
130
131\begin{adjustwidth}{5em}{5em}
132Convert the Java array named by JARRARY into a Lisp list.
133\end{adjustwidth}
134
135\paragraph{}
136\label{JSS:JAVA-CLASS-METHOD-NAMES}
137\index{JAVA-CLASS-METHOD-NAMES}
138--- Function: \textbf{java-class-method-names} [\textbf{jss}] \textit{class \&optional stream}
139
140\begin{adjustwidth}{5em}{5em}
141Return a list of the public methods encapsulated by the JVM CLASS.
142
143If STREAM non-nil, output a verbose description to the named output stream.
144
145CLASS may either be a string naming a fully qualified JVM class in dot
146notation, or a symbol resolved against all class entries in the
147current classpath.
148\end{adjustwidth}
149
150\paragraph{}
151\label{JSS:JCLASS-ALL-INTERFACES}
152\index{JCLASS-ALL-INTERFACES}
153--- Function: \textbf{jclass-all-interfaces} [\textbf{jss}] \textit{class}
154
155\begin{adjustwidth}{5em}{5em}
156Return a list of interfaces the class implements
157\end{adjustwidth}
158
159\paragraph{}
160\label{JSS:JCMN}
161\index{JCMN}
162--- Function: \textbf{jcmn} [\textbf{jss}] \textit{class \&optional stream}
163
164\begin{adjustwidth}{5em}{5em}
165Return a list of the public methods encapsulated by the JVM CLASS.
166
167If STREAM non-nil, output a verbose description to the named output stream.
168
169CLASS may either be a string naming a fully qualified JVM class in dot
170notation, or a symbol resolved against all class entries in the
171current classpath.
172\end{adjustwidth}
173
174\paragraph{}
175\label{JSS:JLIST-TO-LIST}
176\index{JLIST-TO-LIST}
177--- Function: \textbf{jlist-to-list} [\textbf{jss}] \textit{list}
178
179\begin{adjustwidth}{5em}{5em}
180Convert a LIST implementing java.util.List to a Lisp list.
181\end{adjustwidth}
182
183\paragraph{}
184\label{JSS:LIST-TO-LIST}
185\index{LIST-TO-LIST}
186--- Function: \textbf{list-to-list} [\textbf{jss}] \textit{list}
187
188\begin{adjustwidth}{5em}{5em}
189not-documented
190\end{adjustwidth}
191
192\paragraph{}
193\label{JSS:NEW}
194\index{NEW}
195--- Function: \textbf{new} [\textbf{jss}] \textit{class-name \&rest args}
196
197\begin{adjustwidth}{5em}{5em}
198Invoke the Java constructor for CLASS-NAME with ARGS.
199
200CLASS-NAME may either be a symbol or a string according to the usual JSS conventions.
201\end{adjustwidth}
202
203\paragraph{}
204\label{JSS:SET-JAVA-FIELD}
205\index{SET-JAVA-FIELD}
206--- Function: \textbf{set-java-field} [\textbf{jss}] \textit{object field value \&optional (try-harder *running-in-osgi*)}
207
208\begin{adjustwidth}{5em}{5em}
209Set the FIELD of OBJECT to VALUE.
210If OBJECT is a symbol, it names a dot qualified Java class to look for
211a static FIELD.  If OBJECT is an instance of java:java-object, the
212associated is used to look up the static FIELD.
213\end{adjustwidth}
214
215\paragraph{}
216\label{JSS:SET-TO-LIST}
217\index{SET-TO-LIST}
218--- Function: \textbf{set-to-list} [\textbf{jss}] \textit{set}
219
220\begin{adjustwidth}{5em}{5em}
221Convert the java.util.Set named in SET to a Lisp list.
222\end{adjustwidth}
223
224\paragraph{}
225\label{JSS:VECTOR-TO-LIST}
226\index{VECTOR-TO-LIST}
227--- Function: \textbf{vector-to-list} [\textbf{jss}] \textit{vector}
228
229\begin{adjustwidth}{5em}{5em}
230Return the elements of java.lang.Vector VECTOR as a list.
231\end{adjustwidth}
232
233\paragraph{}
234\label{JSS:WITH-CONSTANT-SIGNATURE}
235\index{WITH-CONSTANT-SIGNATURE}
236--- Macro: \textbf{with-constant-signature} [\textbf{jss}] \textit{}
237
238\begin{adjustwidth}{5em}{5em}
239Expand all references to FNAME-JNAME-PAIRS in BODY into static function calls promising that the same function bound in the FNAME-JNAME-PAIRS will be invoked with the same argument signature.
240
241FNAME-JNAME-PAIRS is a list of (symbol function \&optional raw)
242elements where symbol will be the symbol bound to the method named by
243the string function.  If the optional parameter raw is non-nil, the
244result will be the raw JVM object, uncoerced by the usual conventions.
245
246Use this macro if you are making a lot of calls and
247want to avoid the overhead of the dynamic dispatch.
248\end{adjustwidth}
249
Note: See TracBrowser for help on using the repository browser.