| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Wed Apr 14 08:26:32 EDT 2004 --> |
| <TITLE> |
| Velocity 1.4 API: Class AbstractContext |
| </TITLE> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <BODY BGCOLOR="white"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <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/AbstractContext.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/velocity/context/InternalContextAdapterImpl.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="AbstractContext.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <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> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.velocity.context</FONT> |
| <BR> |
| Class AbstractContext</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<A HREF="../../../../org/apache/velocity/context/InternalContextBase.html">org.apache.velocity.context.InternalContextBase</A> |
| | |
| +--<B>org.apache.velocity.context.AbstractContext</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/velocity/context/Context.html">Context</A>, <A HREF="../../../../org/apache/velocity/context/InternalEventContext.html">InternalEventContext</A>, <A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A>, java.io.Serializable</DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/velocity/VelocityContext.html">VelocityContext</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public abstract class <B>AbstractContext</B><DT>extends <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html">InternalContextBase</A><DT>implements <A HREF="../../../../org/apache/velocity/context/Context.html">Context</A>, java.io.Serializable</DL> |
| |
| <P> |
| This class is the abstract base class for all conventional |
| Velocity Context implementations. Simply extend this class |
| and implement the abstract routines that access your preferred |
| storage method. |
| |
| Takes care of context chaining. |
| |
| Also handles / enforces policy on null keys and values : |
| |
| <ul> |
| <li> Null keys and values are accepted and basically dropped. |
| <li> If you place an object into the context with a null key, it |
| will be ignored and logged. |
| <li> If you try to place a null into the context with any key, it |
| will be dropped and logged. |
| </ul> |
| |
| The default implementation of this for application use is |
| org.apache.velocity.VelocityContext. |
| |
| All thanks to Fedor for the chaining idea. |
| <P> |
| <DL> |
| <DT><B>Version: </B><DD>$Id: AbstractContext.java,v 1.8.8.1 2004/03/03 23:22:54 geirm Exp $</DD> |
| <DT><B>Author: </B><DD><a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>, <a href="mailto:fedor.karpelevitch@home.com">Fedor Karpelevitch</a>, <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></DD> |
| <DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.velocity.context.AbstractContext">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- ======== INNER CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private <A HREF="../../../../org/apache/velocity/context/Context.html">Context</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#innerContext">innerContext</A></B></CODE> |
| |
| <BR> |
| the chained Context if any</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.velocity.context.InternalContextBase"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from class org.apache.velocity.context.<A HREF="../../../../org/apache/velocity/context/InternalContextBase.html">InternalContextBase</A></B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#currentResource">currentResource</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#eventCartridge">eventCartridge</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#introspectionCache">introspectionCache</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#templateNameStack">templateNameStack</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#AbstractContext()">AbstractContext</A></B>()</CODE> |
| |
| <BR> |
| default CTOR</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#AbstractContext(org.apache.velocity.context.Context)">AbstractContext</A></B>(<A HREF="../../../../org/apache/velocity/context/Context.html">Context</A> inner)</CODE> |
| |
| <BR> |
| Chaining constructor accepts a Context argument.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></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/velocity/context/AbstractContext.html#containsKey(java.lang.Object)">containsKey</A></B>(java.lang.Object key)</CODE> |
| |
| <BR> |
| Indicates whether the specified key is in the context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#get(java.lang.String)">get</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| Gets the value corresponding to the provided key from the context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/velocity/context/Context.html">Context</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#getChainedContext()">getChainedContext</A></B>()</CODE> |
| |
| <BR> |
| returns innerContext if one is chained</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#getKeys()">getKeys</A></B>()</CODE> |
| |
| <BR> |
| Get all the keys for the values in the context</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#internalContainsKey(java.lang.Object)">internalContainsKey</A></B>(java.lang.Object key)</CODE> |
| |
| <BR> |
| Implement to determine if a key is in the storage.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#internalGet(java.lang.String)">internalGet</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| Implement to return a value from the context storage.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.lang.Object[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#internalGetKeys()">internalGetKeys</A></B>()</CODE> |
| |
| <BR> |
| Implement to return an object array of key |
| strings from your storage.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#internalPut(java.lang.String, java.lang.Object)">internalPut</A></B>(java.lang.String key, |
| java.lang.Object value)</CODE> |
| |
| <BR> |
| Implement to put a value into the context storage.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#internalRemove(java.lang.Object)">internalRemove</A></B>(java.lang.Object key)</CODE> |
| |
| <BR> |
| I mplement to remove an item from your storage.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#put(java.lang.String, java.lang.Object)">put</A></B>(java.lang.String key, |
| java.lang.Object value)</CODE> |
| |
| <BR> |
| Adds a name/value pair to the context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/AbstractContext.html#remove(java.lang.Object)">remove</A></B>(java.lang.Object key)</CODE> |
| |
| <BR> |
| Removes the value associated with the specified key from the context.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.velocity.context.InternalContextBase"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class org.apache.velocity.context.<A HREF="../../../../org/apache/velocity/context/InternalContextBase.html">InternalContextBase</A></B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#attachEventCartridge(org.apache.velocity.app.event.EventCartridge)">attachEventCartridge</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#getCurrentResource()">getCurrentResource</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#getCurrentTemplateName()">getCurrentTemplateName</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#getEventCartridge()">getEventCartridge</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#getTemplateNameStack()">getTemplateNameStack</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#icacheGet(java.lang.Object)">icacheGet</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#icachePut(java.lang.Object, org.apache.velocity.util.introspection.IntrospectionCacheData)">icachePut</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#popCurrentTemplateName()">popCurrentTemplateName</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#pushCurrentTemplateName(java.lang.String)">pushCurrentTemplateName</A>, <A HREF="../../../../org/apache/velocity/context/InternalContextBase.html#setCurrentResource(org.apache.velocity.runtime.resource.Resource)">setCurrentResource</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="innerContext"><!-- --></A><H3> |
| innerContext</H3> |
| <PRE> |
| private <A HREF="../../../../org/apache/velocity/context/Context.html">Context</A> <B>innerContext</B></PRE> |
| <DL> |
| <DD>the chained Context if any</DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="AbstractContext()"><!-- --></A><H3> |
| AbstractContext</H3> |
| <PRE> |
| public <B>AbstractContext</B>()</PRE> |
| <DL> |
| <DD>default CTOR</DL> |
| <HR> |
| |
| <A NAME="AbstractContext(org.apache.velocity.context.Context)"><!-- --></A><H3> |
| AbstractContext</H3> |
| <PRE> |
| public <B>AbstractContext</B>(<A HREF="../../../../org/apache/velocity/context/Context.html">Context</A> inner)</PRE> |
| <DL> |
| <DD>Chaining constructor accepts a Context argument. |
| It will relay get() operations into this Context |
| in the even the 'local' get() returns null.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>inner</CODE> - context to be chained</DL> |
| </DD> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="internalGet(java.lang.String)"><!-- --></A><H3> |
| internalGet</H3> |
| <PRE> |
| public abstract java.lang.Object <B>internalGet</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD>Implement to return a value from the context storage. |
| <br><br> |
| The implementation of this method is required for proper |
| operation of a Context implementation in general |
| Velocity use.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - key whose associated value is to be returned<DT><B>Returns:</B><DD>object stored in the context</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="internalPut(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| internalPut</H3> |
| <PRE> |
| public abstract java.lang.Object <B>internalPut</B>(java.lang.String key, |
| java.lang.Object value)</PRE> |
| <DL> |
| <DD>Implement to put a value into the context storage. |
| <br><br> |
| The implementation of this method is required for |
| proper operation of a Context implementation in |
| general Velocity use.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - key with which to associate the value<DD><CODE>value</CODE> - value to be associated with the key<DT><B>Returns:</B><DD>previously stored value if exists, or null</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="internalContainsKey(java.lang.Object)"><!-- --></A><H3> |
| internalContainsKey</H3> |
| <PRE> |
| public abstract boolean <B>internalContainsKey</B>(java.lang.Object key)</PRE> |
| <DL> |
| <DD>Implement to determine if a key is in the storage. |
| <br><br> |
| Currently, this method is not used internally by |
| the Velocity core.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to test for existance<DT><B>Returns:</B><DD>true if found, false if not</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="internalGetKeys()"><!-- --></A><H3> |
| internalGetKeys</H3> |
| <PRE> |
| public abstract java.lang.Object[] <B>internalGetKeys</B>()</PRE> |
| <DL> |
| <DD>Implement to return an object array of key |
| strings from your storage. |
| <br><br> |
| Currently, this method is not used internally by |
| the Velocity core.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Returns:</B><DD>array of keys</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="internalRemove(java.lang.Object)"><!-- --></A><H3> |
| internalRemove</H3> |
| <PRE> |
| public abstract java.lang.Object <B>internalRemove</B>(java.lang.Object key)</PRE> |
| <DL> |
| <DD>I mplement to remove an item from your storage. |
| <br><br> |
| Currently, this method is not used internally by |
| the Velocity core.<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to remove<DT><B>Returns:</B><DD>object removed if exists, else null</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="put(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| put</H3> |
| <PRE> |
| public java.lang.Object <B>put</B>(java.lang.String key, |
| java.lang.Object value)</PRE> |
| <DL> |
| <DD>Adds a name/value pair to the context.<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/Context.html#put(java.lang.String, java.lang.Object)">put</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/Context.html">Context</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The name to key the provided value with.<DD><CODE>value</CODE> - The corresponding value.<DT><B>Returns:</B><DD>Object that was replaced in the the Context if |
| applicable or null if not.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get(java.lang.String)"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| public java.lang.Object <B>get</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD>Gets the value corresponding to the provided key from the context. |
| |
| Supports the chaining context mechanism. If the 'local' context |
| doesn't have the value, we try to get it from the chained context.<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/Context.html#get(java.lang.String)">get</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/Context.html">Context</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The name of the desired value.<DT><B>Returns:</B><DD>The value corresponding to the provided key or null if |
| the key param is null.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3> |
| containsKey</H3> |
| <PRE> |
| public boolean <B>containsKey</B>(java.lang.Object key)</PRE> |
| <DL> |
| <DD>Indicates whether the specified key is in the context. Provided for |
| debugging purposes.<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/Context.html#containsKey(java.lang.Object)">containsKey</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/Context.html">Context</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The key to look for.<DT><B>Returns:</B><DD>true if the key is in the context, false if not.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKeys()"><!-- --></A><H3> |
| getKeys</H3> |
| <PRE> |
| public java.lang.Object[] <B>getKeys</B>()</PRE> |
| <DL> |
| <DD>Get all the keys for the values in the context<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/Context.html#getKeys()">getKeys</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/Context.html">Context</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Returns:</B><DD>Object[] of keys in the Context. Does not return |
| keys in chained context.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="remove(java.lang.Object)"><!-- --></A><H3> |
| remove</H3> |
| <PRE> |
| public java.lang.Object <B>remove</B>(java.lang.Object key)</PRE> |
| <DL> |
| <DD>Removes the value associated with the specified key from the context.<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/Context.html#remove(java.lang.Object)">remove</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/Context.html">Context</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The name of the value to remove.<DT><B>Returns:</B><DD>The value that the key was mapped to, or <code>null</code> |
| if unmapped.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getChainedContext()"><!-- --></A><H3> |
| getChainedContext</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/velocity/context/Context.html">Context</A> <B>getChainedContext</B>()</PRE> |
| <DL> |
| <DD>returns innerContext if one is chained<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Returns:</B><DD>Context if chained, <code>null</code> if not</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <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/AbstractContext.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/velocity/context/InternalContextAdapterImpl.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="AbstractContext.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <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> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2002 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |
