source: trunk/abcl/doc/manual/jss.tex @ 14892

Last change on this file since 14892 was 14892, checked in by mevenson, 14 months ago

metadata: publish all artifacts for 1.4.0 simultaneously

Update the README <file:README>, CHANGES <file:CHANGES> and the User
manual <file:doc/manual/> for 1.4.0.

<http://abcl.org/trac/changeset/14891>

File size: 7.0 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:JAPROPOS}
101\index{JAPROPOS}
102--- Function: \textbf{japropos} [\textbf{jss}] \textit{string}
103
104\begin{adjustwidth}{5em}{5em}
105Output the names of all Java class names loaded in the current process which match STRING..
106\end{adjustwidth}
107
108\paragraph{}
109\label{JSS:JAR-IMPORT}
110\index{JAR-IMPORT}
111--- Function: \textbf{jar-import} [\textbf{jss}] \textit{file}
112
113\begin{adjustwidth}{5em}{5em}
114Import all the Java classes contained in the pathname FILE into the JSS dynamic lookup cache.
115\end{adjustwidth}
116
117\paragraph{}
118\label{JSS:JARRAY-TO-LIST}
119\index{JARRAY-TO-LIST}
120--- Function: \textbf{jarray-to-list} [\textbf{jss}] \textit{jarray}
121
122\begin{adjustwidth}{5em}{5em}
123Convert the Java array named by JARRARY into a Lisp list.
124\end{adjustwidth}
125
126\paragraph{}
127\label{JSS:JAVA-CLASS-METHOD-NAMES}
128\index{JAVA-CLASS-METHOD-NAMES}
129--- Function: \textbf{java-class-method-names} [\textbf{jss}] \textit{class \&optional stream}
130
131\begin{adjustwidth}{5em}{5em}
132Return a list of the public methods encapsulated by the JVM CLASS.
133
134If STREAM non-nil, output a verbose description to the named output stream.
135
136CLASS may either be a string naming a fully qualified JVM class in dot
137notation, or a symbol resolved against all class entries in the
138current classpath.
139\end{adjustwidth}
140
141\paragraph{}
142\label{JSS:JCLASS-ALL-INTERFACES}
143\index{JCLASS-ALL-INTERFACES}
144--- Function: \textbf{jclass-all-interfaces} [\textbf{jss}] \textit{class}
145
146\begin{adjustwidth}{5em}{5em}
147Return a list of interfaces the class implements
148\end{adjustwidth}
149
150\paragraph{}
151\label{JSS:JCMN}
152\index{JCMN}
153--- Function: \textbf{jcmn} [\textbf{jss}] \textit{}
154
155\begin{adjustwidth}{5em}{5em}
156not-documented
157\end{adjustwidth}
158
159\paragraph{}
160\label{JSS:JLIST-TO-LIST}
161\index{JLIST-TO-LIST}
162--- Function: \textbf{jlist-to-list} [\textbf{jss}] \textit{list}
163
164\begin{adjustwidth}{5em}{5em}
165Convert a LIST implementing java.util.List to a Lisp list.
166\end{adjustwidth}
167
168\paragraph{}
169\label{JSS:LIST-TO-LIST}
170\index{LIST-TO-LIST}
171--- Function: \textbf{list-to-list} [\textbf{jss}] \textit{list}
172
173\begin{adjustwidth}{5em}{5em}
174not-documented
175\end{adjustwidth}
176
177\paragraph{}
178\label{JSS:NEW}
179\index{NEW}
180--- Function: \textbf{new} [\textbf{jss}] \textit{class-name \&rest args}
181
182\begin{adjustwidth}{5em}{5em}
183Invoke the Java constructor for CLASS-NAME with ARGS.
184
185CLASS-NAME may either be a symbol or a string according to the usual JSS conventions.
186\end{adjustwidth}
187
188\paragraph{}
189\label{JSS:SET-JAVA-FIELD}
190\index{SET-JAVA-FIELD}
191--- Function: \textbf{set-java-field} [\textbf{jss}] \textit{object field value \&optional (try-harder *running-in-osgi*)}
192
193\begin{adjustwidth}{5em}{5em}
194Set the FIELD of OBJECT to VALUE.
195If OBJECT is a symbol, it names a dot qualified Java class to look for
196a static FIELD.  If OBJECT is an instance of java:java-object, the
197associated is used to look up the static FIELD.
198\end{adjustwidth}
199
200\paragraph{}
201\label{JSS:SET-TO-LIST}
202\index{SET-TO-LIST}
203--- Function: \textbf{set-to-list} [\textbf{jss}] \textit{set}
204
205\begin{adjustwidth}{5em}{5em}
206not-documented
207\end{adjustwidth}
208
209\paragraph{}
210\label{JSS:VECTOR-TO-LIST}
211\index{VECTOR-TO-LIST}
212--- Function: \textbf{vector-to-list} [\textbf{jss}] \textit{vector}
213
214\begin{adjustwidth}{5em}{5em}
215Return the elements of java.lang.Vector VECTOR as a list.
216\end{adjustwidth}
217
218\paragraph{}
219\label{JSS:WITH-CONSTANT-SIGNATURE}
220\index{WITH-CONSTANT-SIGNATURE}
221--- Macro: \textbf{with-constant-signature} [\textbf{jss}] \textit{}
222
223\begin{adjustwidth}{5em}{5em}
224Expand 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.
225
226FNAME-JNAME-PAIRS is a list of (symbol function \&optional raw)
227elements where symbol will be the symbol bound to the method named by
228the string function.  If the optional parameter raw is non-nil, the
229result will be the raw JVM object, uncoerced by the usual conventions.
230
231Use this macro if you are making a lot of calls and
232want to avoid the overhead of the dynamic dispatch.
233\end{adjustwidth}
234
Note: See TracBrowser for help on using the repository browser.