source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/Cache.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 12.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:34 NZST 2007 -->
6<TITLE>
7Cache (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.selectors.modifiedselector.Cache interface">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="Cache (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/Algorithm.html" title="interface in org.apache.tools.ant.types.selectors.modifiedselector"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;NEXT CLASS</FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="Cache.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.types.selectors.modifiedselector</FONT>
85<BR>
86Interface Cache</H2>
87<DL>
88<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.html" title="class in org.apache.tools.ant.types.selectors.modifiedselector">PropertiesfileCache</A></DD>
89</DL>
90<HR>
91<DL>
92<DT>public interface <B>Cache</B></DL>
93
94<P>
95A Cache let the user store key-value-pairs in a permanent manner and access
96 them.
97 It is possible that a client uses get() before load() therefore the
98 implementation must ensure that no error occurred because of the wrong
99 <i>order</i>.
100 The implementing class should implement a useful toString() method.
101<P>
102
103<P>
104<DL>
105<DT><B>Since:</B></DT>
106 <DD>Ant 1.6</DD>
107<DT><B>Version:</B></DT>
108 <DD>2003-09-13</DD>
109</DL>
110<HR>
111
112<P>
113<!-- ======== NESTED CLASS SUMMARY ======== -->
114
115
116<!-- =========== FIELD SUMMARY =========== -->
117
118
119<!-- ======== CONSTRUCTOR SUMMARY ======== -->
120
121
122<!-- ========== METHOD SUMMARY =========== -->
123
124<A NAME="method_summary"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127<TD COLSPAN=2><FONT SIZE="+2">
128<B>Method Summary</B></FONT></TD>
129</TR>
130<TR BGCOLOR="white" CLASS="TableRowColor">
131<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132<CODE>&nbsp;void</CODE></FONT></TD>
133<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/Cache.html#delete()">delete</A></B>()</CODE>
134
135<BR>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the cache.</TD>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/Cache.html#get(java.lang.Object)">get</A></B>(java.lang.Object&nbsp;key)</CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a value for a given key from the cache.</TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>&nbsp;boolean</CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/Cache.html#isValid()">isValid</A></B>()</CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks its prerequisites.</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>&nbsp;java.util.Iterator</CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/Cache.html#iterator()">iterator</A></B>()</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an iterator over the keys in the cache.</TD>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164<CODE>&nbsp;void</CODE></FONT></TD>
165<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/Cache.html#load()">load</A></B>()</CODE>
166
167<BR>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads the cache, must handle not existing cache.</TD>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172<CODE>&nbsp;void</CODE></FONT></TD>
173<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/Cache.html#put(java.lang.Object, java.lang.Object)">put</A></B>(java.lang.Object&nbsp;key,
174 java.lang.Object&nbsp;value)</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Saves a key-value-pair in the cache.</TD>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<CODE>&nbsp;void</CODE></FONT></TD>
182<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/Cache.html#save()">save</A></B>()</CODE>
183
184<BR>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Saves modification of the cache.</TD>
186</TR>
187</TABLE>
188&nbsp;
189<P>
190
191<!-- ============ FIELD DETAIL =========== -->
192
193
194<!-- ========= CONSTRUCTOR DETAIL ======== -->
195
196
197<!-- ============ METHOD DETAIL ========== -->
198
199<A NAME="method_detail"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202<TD COLSPAN=1><FONT SIZE="+2">
203<B>Method Detail</B></FONT></TD>
204</TR>
205</TABLE>
206
207<A NAME="isValid()"><!-- --></A><H3>
208isValid</H3>
209<PRE>
210public boolean <B>isValid</B>()</PRE>
211<DL>
212<DD>Checks its prerequisites.
213<P>
214<DD><DL>
215
216<DT><B>Returns:</B><DD><i>true</i> if all is ok, otherwise <i>false</i>.</DL>
217</DD>
218</DL>
219<HR>
220
221<A NAME="delete()"><!-- --></A><H3>
222delete</H3>
223<PRE>
224public void <B>delete</B>()</PRE>
225<DL>
226<DD>Deletes the cache. If file based the file has to be deleted also.
227<P>
228<DD><DL>
229</DL>
230</DD>
231</DL>
232<HR>
233
234<A NAME="load()"><!-- --></A><H3>
235load</H3>
236<PRE>
237public void <B>load</B>()</PRE>
238<DL>
239<DD>Loads the cache, must handle not existing cache.
240<P>
241<DD><DL>
242</DL>
243</DD>
244</DL>
245<HR>
246
247<A NAME="save()"><!-- --></A><H3>
248save</H3>
249<PRE>
250public void <B>save</B>()</PRE>
251<DL>
252<DD>Saves modification of the cache.
253<P>
254<DD><DL>
255</DL>
256</DD>
257</DL>
258<HR>
259
260<A NAME="get(java.lang.Object)"><!-- --></A><H3>
261get</H3>
262<PRE>
263public java.lang.Object <B>get</B>(java.lang.Object&nbsp;key)</PRE>
264<DL>
265<DD>Returns a value for a given key from the cache.
266<P>
267<DD><DL>
268<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key
269<DT><B>Returns:</B><DD>the stored value</DL>
270</DD>
271</DL>
272<HR>
273
274<A NAME="put(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
275put</H3>
276<PRE>
277public void <B>put</B>(java.lang.Object&nbsp;key,
278 java.lang.Object&nbsp;value)</PRE>
279<DL>
280<DD>Saves a key-value-pair in the cache.
281<P>
282<DD><DL>
283<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key<DD><CODE>value</CODE> - the value</DL>
284</DD>
285</DL>
286<HR>
287
288<A NAME="iterator()"><!-- --></A><H3>
289iterator</H3>
290<PRE>
291public java.util.Iterator <B>iterator</B>()</PRE>
292<DL>
293<DD>Returns an iterator over the keys in the cache.
294<P>
295<DD><DL>
296
297<DT><B>Returns:</B><DD>An iterator over the keys.</DL>
298</DD>
299</DL>
300<!-- ========= END OF CLASS DATA ========= -->
301<HR>
302
303
304<!-- ======= START OF BOTTOM NAVBAR ====== -->
305<A NAME="navbar_bottom"><!-- --></A>
306<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
307<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
308<TR>
309<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
310<A NAME="navbar_bottom_firstrow"><!-- --></A>
311<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
312 <TR ALIGN="center" VALIGN="top">
313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
315 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
320 </TR>
321</TABLE>
322</TD>
323<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
324</EM>
325</TD>
326</TR>
327
328<TR>
329<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
330&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/types/selectors/modifiedselector/Algorithm.html" title="interface in org.apache.tools.ant.types.selectors.modifiedselector"><B>PREV CLASS</B></A>&nbsp;
331&nbsp;NEXT CLASS</FONT></TD>
332<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
333 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
334&nbsp;<A HREF="Cache.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
335&nbsp;<SCRIPT type="text/javascript">
336 <!--
337 if(window==top) {
338 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
339 }
340 //-->
341</SCRIPT>
342<NOSCRIPT>
343 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
344</NOSCRIPT>
345
346</FONT></TD>
347</TR>
348<TR>
349<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
350 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
351<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
352DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
353</TR>
354</TABLE>
355<A NAME="skip-navbar_bottom"></A>
356<!-- ======== END OF BOTTOM NAVBAR ======= -->
357
358<HR>
359Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
360</BODY>
361</HTML>
Note: See TracBrowser for help on using the repository browser.