source: branches/1.1.x/doc/manual/jss.tex @ 14282

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

manual: Updates to manual for ABCL 1.1.

Preface to the second addition. TODO TeX.

Added Appendix for SYSTEM and JSS packages. TODO Need to fix LaTex?.

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