1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_03) on Fri Jan 25 23:29:21 CET 2008 -->
<TITLE>
ClassCache (JiBX Java data binding to XML - Version 1.0)
</TITLE>
<META NAME="date" CONTENT="2008-01-25">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClassCache (JiBX Java data binding to XML - Version 1.0)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/jibx/binding/classes/BranchWrapper.html" title="class in org.jibx.binding.classes"><B>PREV CLASS</B></A>
<A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/jibx/binding/classes/ClassCache.html" target="_top"><B>FRAMES</B></A>
<A HREF="ClassCache.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.jibx.binding.classes</FONT>
<BR>
Class ClassCache</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.jibx.binding.classes.ClassCache</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>ClassCache</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Cache for class files being modified. Handles loading and saving of class
files. Classes are loaded directly from the file system paths supplied on
initialization in preference to the system class path.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>1.0</DD>
<DT><B>Author:</B></DT>
<DD>Dennis M. Sosnoski</DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.util.HashMap</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/classes/ClassCache.html#m_classMap">m_classMap</A></B></CODE>
<BR>
Map from class names to actual class information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/classes/ClassCache.html#m_paths">m_paths</A></B></CODE>
<BR>
Paths to be searched for class files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.io.File[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/classes/ClassCache.html#m_roots">m_roots</A></B></CODE>
<BR>
Root directories corresponding to paths.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static <A HREF="../../../../org/jibx/binding/classes/ClassCache.html" title="class in org.jibx.binding.classes">ClassCache</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/classes/ClassCache.html#s_instance">s_instance</A></B></CODE>
<BR>
Singleton instance of class (created when paths set)</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/classes/ClassCache.html#ClassCache(java.lang.String[])">ClassCache</A></B>(java.lang.String[] paths)</CODE>
<BR>
Constructor.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/classes/ClassCache.html#addClassFile(org.jibx.binding.classes.ClassFile)">addClassFile</A></B>(<A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf)</CODE>
<BR>
Add created class information to cache.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/classes/ClassCache.html#getClassFile(java.lang.String)">getClassFile</A></B>(java.lang.String name)</CODE>
<BR>
Get class information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private <A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/classes/ClassCache.html#getClassFileImpl(java.lang.String)">getClassFileImpl</A></B>(java.lang.String name)</CODE>
<BR>
Get class information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/classes/ClassCache.html#setPaths(java.lang.String[])">setPaths</A></B>(java.lang.String[] paths)</CODE>
<BR>
Set class paths to be searched.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="s_instance"><!-- --></A><H3>
s_instance</H3>
<PRE>
private static <A HREF="../../../../org/jibx/binding/classes/ClassCache.html" title="class in org.jibx.binding.classes">ClassCache</A> <B>s_instance</B></PRE>
<DL>
<DD>Singleton instance of class (created when paths set)
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_paths"><!-- --></A><H3>
m_paths</H3>
<PRE>
private java.lang.String[] <B>m_paths</B></PRE>
<DL>
<DD>Paths to be searched for class files.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_roots"><!-- --></A><H3>
m_roots</H3>
<PRE>
private java.io.File[] <B>m_roots</B></PRE>
<DL>
<DD>Root directories corresponding to paths.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_classMap"><!-- --></A><H3>
m_classMap</H3>
<PRE>
private java.util.HashMap <B>m_classMap</B></PRE>
<DL>
<DD>Map from class names to actual class information.
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ClassCache(java.lang.String[])"><!-- --></A><H3>
ClassCache</H3>
<PRE>
private <B>ClassCache</B>(java.lang.String[] paths)</PRE>
<DL>
<DD>Constructor. Discards jar file paths and normalizes all other paths
(except the empty path) to end with the system path separator character.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>paths</CODE> - ordered set of paths to be searched for class files</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getClassFileImpl(java.lang.String)"><!-- --></A><H3>
getClassFileImpl</H3>
<PRE>
private <A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> <B>getClassFileImpl</B>(java.lang.String name)
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Get class information. Looks up the class in cache, and if not already
present tries to find it based on the class file search path list. If
the class file is found it is loaded and this method calls itself
recursively to load the whole hierarchy of superclasses.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - fully-qualified name of class to be found
<DT><B>Returns:</B><DD>class information, or <code>null</code> if class not found
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - on any error accessing class file</DL>
</DD>
</DL>
<HR>
<A NAME="getClassFile(java.lang.String)"><!-- --></A><H3>
getClassFile</H3>
<PRE>
public static <A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> <B>getClassFile</B>(java.lang.String name)
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Get class information. Looks up the class in cache, and if not already
present tries to find it based on the class file search path list. If
the class file is found it is loaded along with all superclasses.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - fully-qualified name of class to be found
<DT><B>Returns:</B><DD>class information, or <code>null</code> if class not found
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - on any error accessing class file</DL>
</DD>
</DL>
<HR>
<A NAME="addClassFile(org.jibx.binding.classes.ClassFile)"><!-- --></A><H3>
addClassFile</H3>
<PRE>
static void <B>addClassFile</B>(<A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> cf)</PRE>
<DL>
<DD>Add created class information to cache.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cf</CODE> - information for class to be added</DL>
</DD>
</DL>
<HR>
<A NAME="setPaths(java.lang.String[])"><!-- --></A><H3>
setPaths</H3>
<PRE>
public static void <B>setPaths</B>(java.lang.String[] paths)</PRE>
<DL>
<DD>Set class paths to be searched. Discards jar file paths and normalizes
all other paths (except the empty path) to end with the system path
separator character.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>paths</CODE> - ordered set of paths to be searched for class files</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/jibx/binding/classes/BranchWrapper.html" title="class in org.jibx.binding.classes"><B>PREV CLASS</B></A>
<A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/jibx/binding/classes/ClassCache.html" target="_top"><B>FRAMES</B></A>
<A HREF="ClassCache.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<table width='80%%'><tr><td width='50%%'><p align='center'><a href='http://www.jibx.org/' target='_top'><font size='3'><b>Project Web Site</b></font></a></td><td width='50%%'><p align='center'></td></tr></table>
</BODY>
</HTML>
|
