Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/org/apache/fulcrum/cache/CachedObject.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/org/apache/fulcrum/cache/CachedObject.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/org/apache/fulcrum/cache/CachedObject.html Wed Aug 4 05:57:38 2021 @@ -1,523 +1,558 @@ -<!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.5.0_19) on Mon Apr 19 21:20:45 CEST 2010 --> -<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> -<TITLE> -CachedObject (Fulcrum Cache 1.1.0 API) -</TITLE> - -<META NAME="keywords" CONTENT="org.apache.fulcrum.cache.CachedObject class"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="CachedObject (Fulcrum Cache 1.1.0 API)"; -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> - - -<!-- ========= 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="class-use/CachedObject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</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"> - PREV CLASS - <A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html" title="interface in org.apache.fulcrum.cache"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/fulcrum/cache/CachedObject.html" target="_top"><B>FRAMES</B></A> - <A HREF="CachedObject.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.apache.fulcrum.cache</FONT> -<BR> -Class CachedObject</H2> -<PRE> -<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.fulcrum.cache.CachedObject</B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DD> -</DL> -<DL> -<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/fulcrum/cache/RefreshableCachedObject.html" title="class in org.apache.fulcrum.cache">RefreshableCachedObject</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public class <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.33"><B>CachedObject</B></A><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DL> -</PRE> - -<P> -Wrapper for an object you want to store in a cache for a period of time. -<P> - -<P> -<DL> -<DT><B>Version:</B></DT> - <DD>$Id: CachedObject.java 670326 2008-06-22 09:31:47Z tv $</DD> -<DT><B>Author:</B></DT> - <DD><a href="mailto:[email protected]">Dave Bryson</a>, <a href="mailto:[email protected]">Henning P. Schmiedehausen</a>, <a href="mailto:[email protected]">Eric Pugh</a></DD> -<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.fulcrum.cache.CachedObject">Serialized Form</A></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>protected long</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#created">created</A></B></CODE> - -<BR> - When created</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#DEFAULT">DEFAULT</A></B></CODE> - -<BR> - Cache the object with the Default TTL</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#FOREVER">FOREVER</A></B></CODE> - -<BR> - Do not expire the object</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><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#CachedObject(java.lang.Object)">CachedObject</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o)</CODE> - -<BR> - Constructor; sets the object to expire in the default time (30 minutes).</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#CachedObject(java.lang.Object, long)">CachedObject</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o, - long expires)</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> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#getContents()">getContents</A></B>()</CODE> - -<BR> - Returns the cached object.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> long</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#getCreated()">getCreated</A></B>()</CODE> - -<BR> - Returns the creation time for the object.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> long</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#getExpires()">getExpires</A></B>()</CODE> - -<BR> - Returns the expiration time for the object.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#getStale()">getStale</A></B>()</CODE> - -<BR> - Get the stale status for the object.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#isStale()">isStale</A></B>()</CODE> - -<BR> - Is the object stale?</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#setExpires(long)">setExpires</A></B>(long expires)</CODE> - -<BR> - Set the expiration interval for the object.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html#setStale(boolean)">setStale</A></B>(boolean stale)</CODE> - -<BR> - Set the stale status for the object.</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.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/ docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></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="DEFAULT"><!-- --></A><H3> -DEFAULT</H3> -<PRE> -public static final int <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.47"><B>DEFAULT</B></A></PRE> -<DL> -<DD>Cache the object with the Default TTL -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.fulcrum.cache.CachedObject.DEFAULT">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="FOREVER"><!-- --></A><H3> -FOREVER</H3> -<PRE> -public static final int <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.50"><B>FOREVER</B></A></PRE> -<DL> -<DD>Do not expire the object -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.fulcrum.cache.CachedObject.FOREVER">Constant Field Values</A></DL> -</DL> -<HR> - -<A NAME="created"><!-- --></A><H3> -created</H3> -<PRE> -protected long <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.59"><B>created</B></A></PRE> -<DL> -<DD>When created. * -<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="CachedObject(java.lang.Object)"><!-- --></A><H3> -CachedObject</H3> -<PRE> -public <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.73"><B>CachedObject</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o)</PRE> -<DL> -<DD>Constructor; sets the object to expire in the default time (30 minutes). -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>o</CODE> - The object you want to cache.</DL> -</DL> -<HR> - -<A NAME="CachedObject(java.lang.Object, long)"><!-- --></A><H3> -CachedObject</H3> -<PRE> -public <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.89"><B>CachedObject</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o, - long expires)</PRE> -<DL> -<DD>Constructor. -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>o</CODE> - The object to cache.<DD><CODE>expires</CODE> - How long before the object expires, in ms, e.g. 1000 = 1 - second.</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="getContents()"><!-- --></A><H3> -getContents</H3> -<PRE> -public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.106"><B>getContents</B></A>()</PRE> -<DL> -<DD>Returns the cached object. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The cached object.</DL> -</DD> -</DL> -<HR> - -<A NAME="getCreated()"><!-- --></A><H3> -getCreated</H3> -<PRE> -public long <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.116"><B>getCreated</B></A>()</PRE> -<DL> -<DD>Returns the creation time for the object. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>When the object was created.</DL> -</DD> -</DL> -<HR> - -<A NAME="getExpires()"><!-- --></A><H3> -getExpires</H3> -<PRE> -public long <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.126"><B>getExpires</B></A>()</PRE> -<DL> -<DD>Returns the expiration time for the object. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>When the object expires.</DL> -</DD> -</DL> -<HR> - -<A NAME="setExpires(long)"><!-- --></A><H3> -setExpires</H3> -<PRE> -public void <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.137"><B>setExpires</B></A>(long expires)</PRE> -<DL> -<DD>Set the expiration interval for the object. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>expires</CODE> - Expiration interval in millis ( 1 second = 1000 millis)</DL> -</DD> -</DL> -<HR> - -<A NAME="setStale(boolean)"><!-- --></A><H3> -setStale</H3> -<PRE> -public void <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.163"><B>setStale</B></A>(boolean stale)</PRE> -<DL> -<DD>Set the stale status for the object. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>stale</CODE> - Whether the object is stale or not.</DL> -</DD> -</DL> -<HR> - -<A NAME="getStale()"><!-- --></A><H3> -getStale</H3> -<PRE> -public boolean <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.173"><B>getStale</B></A>()</PRE> -<DL> -<DD>Get the stale status for the object. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>Whether the object is stale or not.</DL> -</DD> -</DL> -<HR> - -<A NAME="isStale()"><!-- --></A><H3> -isStale</H3> -<PRE> -public boolean <A HREF="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.183"><B>isStale</B></A>()</PRE> -<DL> -<DD>Is the object stale? -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the object is stale.</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="class-use/CachedObject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</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"> - PREV CLASS - <A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html" title="interface in org.apache.fulcrum.cache"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/fulcrum/cache/CachedObject.html" target="_top"><B>FRAMES</B></A> - <A HREF="CachedObject.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> -Copyright © 2004-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. -</BODY> -</HTML> +<!DOCTYPE HTML> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc --> +<title>CachedObject (Fulcrum Cache 2.0.0 API)</title> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> +<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> +<!--[if IE]> +<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> +<![endif]--> +<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> +<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="CachedObject (Fulcrum Cache 2.0.0 API)"; + } + } + catch(err) { + } +//--> +var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +var pathtoroot = "../../../../"; +var useModuleDirectories = true; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<header role="banner"> +<nav role="navigation"> +<div class="fixedNav"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a id="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CachedObject.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses.html">All Classes</a></li> +</ul> +<ul class="navListSearch"> +<li><label for="search">SEARCH:</label> +<input type="text" id="search" value="search" disabled="disabled"> +<input type="reset" id="reset" value="reset" disabled="disabled"> +</li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +</nav> +</header> +<!-- ======== START OF CLASS DATA ======== --> +<main role="main"> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.fulcrum.cache</a></div> +<h2 title="Class CachedObject" class="title">Class CachedObject<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.fulcrum.cache.CachedObject<T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="RefreshableCachedObject.html" title="class in org.apache.fulcrum.cache">RefreshableCachedObject</a></code></dd> +</dl> +<hr> +<pre>public class <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.34">CachedObject</a><T> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> +implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></pre> +<div class="block">Wrapper for an object you want to store in a cache for a period of time.</div> +<dl> +<dt><span class="simpleTagLabel">Version:</span></dt> +<dd>$Id: CachedObject.java 1890338 2021-05-31 10:31:19Z gk $</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd><a href="mailto:[email protected]">Dave Bryson</a>, <a href="mailto:[email protected]">Henning P. Schmiedehausen</a>, <a href="mailto:[email protected]">Eric Pugh</a></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.fulcrum.cache.CachedObject">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Field</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected long</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#created">created</a></span></code></th> +<td class="colLast"> +<div class="block">When the object is created.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT">DEFAULT</a></span></code></th> +<td class="colLast"> +<div class="block">Cache the object with the Default TTL</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FOREVER">FOREVER</a></span></code></th> +<td class="colLast"> +<div class="block">Do not expire the object</div> +</td> +</tr> +</table> +</li> +</ul> +</section> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(T)">CachedObject</a></span>​(<a href="CachedObject.html" title="type parameter in CachedObject">T</a> object)</code></th> +<td class="colLast"> +<div class="block">Constructor; sets the object to expire in the default time (30 minutes).</div> +</td> +</tr> +<tr class="rowColor"> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(T,long)">CachedObject</a></span>​(<a href="CachedObject.html" title="type parameter in CachedObject">T</a> object, + long expires)</code></th> +<td class="colLast"> +<div class="block">Constructor.</div> +</td> +</tr> +</table> +</li> +</ul> +</section> +<!-- ========== METHOD SUMMARY =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="CachedObject.html" title="type parameter in CachedObject">T</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContents()">getContents</a></span>()</code></th> +<td class="colLast"> +<div class="block">Returns the cached object.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCreated()">getCreated</a></span>()</code></th> +<td class="colLast"> +<div class="block">Returns the creation time for the object.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>long</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpires()">getExpires</a></span>()</code></th> +<td class="colLast"> +<div class="block">Returns the expiration time for the object.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isStale()">isStale</a></span>()</code></th> +<td class="colLast"> +<div class="block">Is the object stale?</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExpires(long)">setExpires</a></span>​(long expires)</code></th> +<td class="colLast"> +<div class="block">Set the expiration interval for the object.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStale(boolean)">setStale</a></span>​(boolean stale)</code></th> +<td class="colLast"> +<div class="block">Set the stale status for the object.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a id="DEFAULT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.48">DEFAULT</a></pre> +<div class="block">Cache the object with the Default TTL</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.fulcrum.cache.CachedObject.DEFAULT">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a id="FOREVER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FOREVER</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.51">FOREVER</a></pre> +<div class="block">Do not expire the object</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.fulcrum.cache.CachedObject.FOREVER">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a id="created"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>created</h4> +<pre>protected long <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.60">created</a></pre> +<div class="block">When the object is created.</div> +</li> +</ul> +</li> +</ul> +</section> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a id="<init>(java.lang.Object)"> +<!-- --> +</a><a id="<init>(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CachedObject</h4> +<pre>public <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.74">CachedObject</a>​(<a href="CachedObject.html" title="type parameter in CachedObject">T</a> object)</pre> +<div class="block">Constructor; sets the object to expire in the default time (30 minutes).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>object</code> - The object you want to cache.</dd> +</dl> +</li> +</ul> +<a id="<init>(java.lang.Object,long)"> +<!-- --> +</a><a id="<init>(T,long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CachedObject</h4> +<pre>public <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.88">CachedObject</a>​(<a href="CachedObject.html" title="type parameter in CachedObject">T</a> object, + long expires)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>object</code> - The object to cache.</dd> +<dd><code>expires</code> - How long before the object expires, in ms, e.g. 1000 = 1 + second.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +<!-- ============ METHOD DETAIL ========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a id="getContents()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getContents</h4> +<pre class="methodSignature">public <a href="CachedObject.html" title="type parameter in CachedObject">T</a> <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.107">getContents</a>()</pre> +<div class="block">Returns the cached object.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The cached object.</dd> +</dl> +</li> +</ul> +<a id="getCreated()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreated</h4> +<pre class="methodSignature">public long <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.117">getCreated</a>()</pre> +<div class="block">Returns the creation time for the object.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>When the object was created.</dd> +</dl> +</li> +</ul> +<a id="getExpires()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExpires</h4> +<pre class="methodSignature">public long <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.127">getExpires</a>()</pre> +<div class="block">Returns the expiration time for the object.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>When the object expires.</dd> +</dl> +</li> +</ul> +<a id="setExpires(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExpires</h4> +<pre class="methodSignature">public void <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.138">setExpires</a>​(long expires)</pre> +<div class="block">Set the expiration interval for the object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>expires</code> - Expiration interval in millis ( 1 second = 1000 millis)</dd> +</dl> +</li> +</ul> +<a id="setStale(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStale</h4> +<pre class="methodSignature">public void <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.164">setStale</a>​(boolean stale)</pre> +<div class="block">Set the stale status for the object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stale</code> - Whether the object is stale or not.</dd> +</dl> +</li> +</ul> +<a id="isStale()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isStale</h4> +<pre class="methodSignature">public boolean <a href="../../../../src-html/org/apache/fulcrum/cache/CachedObject.html#line.175">isStale</a>()</pre> +<div class="block">Is the object stale?</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>True if the object is stale.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +</div> +</main> +<!-- ========= END OF CLASS DATA ========= --> +<footer role="contentinfo"> +<nav role="navigation"> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a id="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CachedObject.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</nav> +<p class="legalCopy"><small>Copyright © 2004–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</body> +</html> \ No newline at end of file
Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/org/apache/fulcrum/cache/GlobalCacheService.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/org/apache/fulcrum/cache/GlobalCacheService.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/org/apache/fulcrum/cache/GlobalCacheService.html Wed Aug 4 05:57:38 2021 @@ -1,448 +1,474 @@ -<!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.5.0_19) on Mon Apr 19 21:20:45 CEST 2010 --> -<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> -<TITLE> -GlobalCacheService (Fulcrum Cache 1.1.0 API) -</TITLE> - -<META NAME="keywords" CONTENT="org.apache.fulcrum.cache.GlobalCacheService interface"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="GlobalCacheService (Fulcrum Cache 1.1.0 API)"; -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> - - -<!-- ========= 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="class-use/GlobalCacheService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</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/apache/fulcrum/cache/CachedObject.html" title="class in org.apache.fulcrum.cache"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/fulcrum/cache/ObjectExpiredException.html" title="class in org.apache.fulcrum.cache"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/fulcrum/cache/GlobalCacheService.html" target="_top"><B>FRAMES</B></A> - <A HREF="GlobalCacheService.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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.apache.fulcrum.cache</FONT> -<BR> -Interface GlobalCacheService</H2> -<DL> -<DT><B>All Superinterfaces:</B> <DD>org.apache.avalon.framework.component.Component</DD> -</DL> -<DL> -<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/fulcrum/cache/impl/DefaultGlobalCacheService.html" title="class in org.apache.fulcrum.cache.impl">DefaultGlobalCacheService</A>, <A HREF="../../../../org/apache/fulcrum/cache/impl/EHCacheService.html" title="class in org.apache.fulcrum.cache.impl">EHCacheService</A>, <A HREF="../../../../org/apache/fulcrum/cache/impl/JCSCacheService.html" title="class in org.apache.fulcrum.cache.impl">JCSCacheService</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public interface <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.34"><B>GlobalCacheService</B></A><DT>extends org.apache.avalon.framework.component.Component</DL> -</PRE> - -<P> -GlobalCacheService interface. -<P> - -<P> -<DL> -<DT><B>Version:</B></DT> - <DD>$Id: GlobalCacheService.java 927153 2010-03-24 18:55:08Z tv $</DD> -<DT><B>Author:</B></DT> - <DD><a href="mailto:[email protected]">Dave Bryson</a>, <a href="mailto:[email protected]">Peter Courcoux</a></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>static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#ROLE">ROLE</A></B></CODE> - -<BR> - Avalon role - used to id the component within the manager</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> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#addObject(java.lang.String, org.apache.fulcrum.cache.CachedObject)">addObject</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id, - <A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</A> o)</CODE> - -<BR> - Adds an object to the cache.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#flushCache()">flushCache</A></B>()</CODE> - -<BR> - Flush the cache of all objects.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#getCachedObjects()">getCachedObjects</A></B>()</CODE> - -<BR> - Returns a copy of the non-expired CachedObjects in the cache as a list.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#getCacheSize()">getCacheSize</A></B>()</CODE> - -<BR> - Returns the current size of the cache.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#getKeys()">getKeys</A></B>()</CODE> - -<BR> - Returns a copy of keys to objects in the cache as a list.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#getNumberOfObjects()">getNumberOfObjects</A></B>()</CODE> - -<BR> - Returns the number of objects in the cache.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#getObject(java.lang.String)">getObject</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id)</CODE> - -<BR> - Gets a cached object given its id (a String).</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/fulcrum/cache/GlobalCacheService.html#removeObject(java.lang.String)">removeObject</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id)</CODE> - -<BR> - Removes an object from the cache.</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="ROLE"><!-- --></A><H3> -ROLE</H3> -<PRE> -static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.37"><B>ROLE</B></A></PRE> -<DL> -<DD>Avalon role - used to id the component within the manager -<P> -<DL> -</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="getObject(java.lang.String)"><!-- --></A><H3> -getObject</H3> -<PRE> -<A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</A> <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.48"><B>getObject</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id) - throws <A HREF="../../../../org/apache/fulcrum/cache/ObjectExpiredException.html" title="class in org.apache.fulcrum.cache">ObjectExpiredException</A></PRE> -<DL> -<DD>Gets a cached object given its id (a String). -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>id</CODE> - The String id for the object. -<DT><B>Returns:</B><DD>A CachedObject. -<DT><B>Throws:</B> -<DD><CODE>ObjectExpiredException,</CODE> - if the object has expired in the cache. -<DD><CODE><A HREF="../../../../org/apache/fulcrum/cache/ObjectExpiredException.html" title="class in org.apache.fulcrum.cache">ObjectExpiredException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="addObject(java.lang.String, org.apache.fulcrum.cache.CachedObject)"><!-- --></A><H3> -addObject</H3> -<PRE> -void <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.58"><B>addObject</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id, - <A HREF="../../../../org/apache/fulcrum/cache/CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</A> o)</PRE> -<DL> -<DD>Adds an object to the cache. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>id</CODE> - The String id for the object.<DD><CODE>o</CODE> - The object to add to the cache.</DL> -</DD> -</DL> -<HR> - -<A NAME="removeObject(java.lang.String)"><!-- --></A><H3> -removeObject</H3> -<PRE> -void <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.66"><B>removeObject</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> id)</PRE> -<DL> -<DD>Removes an object from the cache. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>id</CODE> - The String id for the object.</DL> -</DD> -</DL> -<HR> - -<A NAME="getKeys()"><!-- --></A><H3> -getKeys</H3> -<PRE> -<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.76"><B>getKeys</B></A>()</PRE> -<DL> -<DD>Returns a copy of keys to objects in the cache as a list. - - Note that keys to expired objects are not returned. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>A List of <code>String</code>'s representing the keys to - objects in the cache.</DL> -</DD> -</DL> -<HR> - -<A NAME="getCachedObjects()"><!-- --></A><H3> -getCachedObjects</H3> -<PRE> -<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.83"><B>getCachedObjects</B></A>()</PRE> -<DL> -<DD>Returns a copy of the non-expired CachedObjects in the cache as a list. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>A List of <code>CachedObject</code> objects held in the cache</DL> -</DD> -</DL> -<HR> - -<A NAME="getCacheSize()"><!-- --></A><H3> -getCacheSize</H3> -<PRE> -int <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.90"><B>getCacheSize</B></A>() - throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> -<DL> -<DD>Returns the current size of the cache. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>int representing current cache size in number of bytes -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getNumberOfObjects()"><!-- --></A><H3> -getNumberOfObjects</H3> -<PRE> -int <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.97"><B>getNumberOfObjects</B></A>()</PRE> -<DL> -<DD>Returns the number of objects in the cache. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>int The current number of objects in the cache.</DL> -</DD> -</DL> -<HR> - -<A NAME="flushCache()"><!-- --></A><H3> -flushCache</H3> -<PRE> -void <A HREF="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.102"><B>flushCache</B></A>()</PRE> -<DL> -<DD>Flush the cache of all objects. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</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="class-use/GlobalCacheService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</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/apache/fulcrum/cache/CachedObject.html" title="class in org.apache.fulcrum.cache"><B>PREV CLASS</B></A> - <A HREF="../../../../org/apache/fulcrum/cache/ObjectExpiredException.html" title="class in org.apache.fulcrum.cache"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/fulcrum/cache/GlobalCacheService.html" target="_top"><B>FRAMES</B></A> - <A HREF="GlobalCacheService.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -Copyright © 2004-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. -</BODY> -</HTML> +<!DOCTYPE HTML> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc --> +<title>GlobalCacheService (Fulcrum Cache 2.0.0 API)</title> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> +<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> +<!--[if IE]> +<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> +<![endif]--> +<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> +<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="GlobalCacheService (Fulcrum Cache 2.0.0 API)"; + } + } + catch(err) { + } +//--> +var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +var pathtoroot = "../../../../"; +var useModuleDirectories = true; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<header role="banner"> +<nav role="navigation"> +<div class="fixedNav"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a id="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/GlobalCacheService.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses.html">All Classes</a></li> +</ul> +<ul class="navListSearch"> +<li><label for="search">SEARCH:</label> +<input type="text" id="search" value="search" disabled="disabled"> +<input type="reset" id="reset" value="reset" disabled="disabled"> +</li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +</nav> +</header> +<!-- ======== START OF CLASS DATA ======== --> +<main role="main"> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.fulcrum.cache</a></div> +<h2 title="Interface GlobalCacheService" class="title">Interface GlobalCacheService</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><code><a href="impl/DefaultGlobalCacheService.html" title="class in org.apache.fulcrum.cache.impl">DefaultGlobalCacheService</a></code>, <code><a href="impl/EHCacheService.html" title="class in org.apache.fulcrum.cache.impl">EHCacheService</a></code>, <code><a href="impl/JCSCacheService.html" title="class in org.apache.fulcrum.cache.impl">JCSCacheService</a></code></dd> +</dl> +<hr> +<pre>public interface <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.32">GlobalCacheService</a></pre> +<div class="block">GlobalCacheService interface.</div> +<dl> +<dt><span class="simpleTagLabel">Version:</span></dt> +<dd>$Id: GlobalCacheService.java 1890075 2021-05-21 15:04:52Z painter $</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd><a href="mailto:[email protected]">Dave Bryson</a>, <a href="mailto:[email protected]">Peter CourefreshableCachedObjectux</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Field</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ROLE">ROLE</a></span></code></th> +<td class="colLast"> +<div class="block">Avalon role - used to id the component within the manager</div> +</td> +</tr> +</table> +</li> +</ul> +</section> +<!-- ========== METHOD SUMMARY =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><T> void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addObject(java.lang.String,org.apache.fulcrum.cache.CachedObject)">addObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objectId, + <a href="CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</a><T> object)</code></th> +<td class="colLast"> +<div class="block">Adds an object to the cache.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flushCache()">flushCache</a></span>()</code></th> +<td class="colLast"> +<div class="block">Flush the cache of all objects.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</a><?>></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCachedObjects()">getCachedObjects</a></span>()</code></th> +<td class="colLast"> +<div class="block">Returns a copy of the non-expired CachedObjects in the cache as a list.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheSize()">getCacheSize</a></span>()</code></th> +<td class="colLast"> +<div class="block">Returns the current size of the cache.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeys()">getKeys</a></span>()</code></th> +<td class="colLast"> +<div class="block">Returns a copy of keys to objects in the cache as a list.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumberOfObjects()">getNumberOfObjects</a></span>()</code></th> +<td class="colLast"> +<div class="block">Returns the number of objects in the cache.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><T> <a href="CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</a><T></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObject(java.lang.String)">getObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objectId)</code></th> +<td class="colLast"> +<div class="block">Gets a cached object given its id (a String).</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeObject(java.lang.String)">removeObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objectId)</code></th> +<td class="colLast"> +<div class="block">Removes an object from the cache.</div> +</td> +</tr> +</table> +</li> +</ul> +</section> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a id="ROLE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ROLE</h4> +<pre>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.35">ROLE</a></pre> +<div class="block">Avalon role - used to id the component within the manager</div> +</li> +</ul> +</li> +</ul> +</section> +<!-- ============ METHOD DETAIL ========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a id="getObject(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getObject</h4> +<pre class="methodSignature"><T> <a href="CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</a><T> <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.47">getObject</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objectId) + throws <a href="ObjectExpiredException.html" title="class in org.apache.fulcrum.cache">ObjectExpiredException</a></pre> +<div class="block">Gets a cached object given its id (a String).</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - type of object to return</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>objectId</code> - The String id for the object.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A CachedObject.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="ObjectExpiredException.html" title="class in org.apache.fulcrum.cache">ObjectExpiredException</a></code> - if the object has expired in the cache.</dd> +</dl> +</li> +</ul> +<a id="addObject(java.lang.String,org.apache.fulcrum.cache.CachedObject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addObject</h4> +<pre class="methodSignature"><T> void <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.58">addObject</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objectId, + <a href="CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</a><T> object)</pre> +<div class="block">Adds an object to the cache.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - type of object to add</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>objectId</code> - The String id for the object.</dd> +<dd><code>object</code> - The object to add to the cache.</dd> +</dl> +</li> +</ul> +<a id="removeObject(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeObject</h4> +<pre class="methodSignature">void <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.66">removeObject</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objectId)</pre> +<div class="block">Removes an object from the cache.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>objectId</code> - The String id for the object.</dd> +</dl> +</li> +</ul> +<a id="getKeys()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeys</h4> +<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.76">getKeys</a>()</pre> +<div class="block">Returns a copy of keys to objects in the cache as a list. + + Note that keys to expired objects are not returned.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A List of <code>String</code>'s representing the keys to + objects in the cache.</dd> +</dl> +</li> +</ul> +<a id="getCachedObjects()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCachedObjects</h4> +<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="CachedObject.html" title="class in org.apache.fulcrum.cache">CachedObject</a><?>> <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.83">getCachedObjects</a>()</pre> +<div class="block">Returns a copy of the non-expired CachedObjects in the cache as a list.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A List of <code>CachedObject</code> objects held in the cache</dd> +</dl> +</li> +</ul> +<a id="getCacheSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheSize</h4> +<pre class="methodSignature">int <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.91">getCacheSize</a>() + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre> +<div class="block">Returns the current size of the cache.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>int representing current cache size in number of bytes</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - if unable to return cache size</dd> +</dl> +</li> +</ul> +<a id="getNumberOfObjects()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumberOfObjects</h4> +<pre class="methodSignature">int <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.98">getNumberOfObjects</a>()</pre> +<div class="block">Returns the number of objects in the cache.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>int The current number of objects in the cache.</dd> +</dl> +</li> +</ul> +<a id="flushCache()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>flushCache</h4> +<pre class="methodSignature">void <a href="../../../../src-html/org/apache/fulcrum/cache/GlobalCacheService.html#line.103">flushCache</a>()</pre> +<div class="block">Flush the cache of all objects.</div> +</li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +</div> +</main> +<!-- ========= END OF CLASS DATA ========= --> +<footer role="contentinfo"> +<nav role="navigation"> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a id="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/GlobalCacheService.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</nav> +<p class="legalCopy"><small>Copyright © 2004–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</body> +</html> \ No newline at end of file
