| <!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 VMContext |
| </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/VMContext.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/velocity/context/InternalContextBase.html"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="VMContext.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 VMContext</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.velocity.context.VMContext</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/InternalContextAdapter.html">InternalContextAdapter</A>, <A HREF="../../../../org/apache/velocity/context/InternalEventContext.html">InternalEventContext</A>, <A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A>, <A HREF="../../../../org/apache/velocity/context/InternalWrapperContext.html">InternalWrapperContext</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>VMContext</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</A></DL> |
| |
| <P> |
| This is a special, internal-use-only context implementation to be |
| used for the new Velocimacro implementation. |
| |
| The main distinguishing feature is the management of the VMProxyArg objects |
| in the put() and get() methods. |
| |
| Further, this context also supports the 'VM local context' mode, where |
| any get() or put() of references that aren't args to the VM are considered |
| local to the vm, protecting the global context. |
| <P> |
| <DL> |
| <DT><B>Version: </B><DD>$Id: VMContext.java,v 1.9.10.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></DD> |
| </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>(package private) <A HREF="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#innerContext">innerContext</A></B></CODE> |
| |
| <BR> |
| the base context store.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>(package private) java.util.HashMap</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#localcontext">localcontext</A></B></CODE> |
| |
| <BR> |
| container for any local or constant VMProxy items</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#localcontextscope">localcontextscope</A></B></CODE> |
| |
| <BR> |
| support for local context scope feature, where all references are local</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>(package private) java.util.HashMap</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#vmproxyhash">vmproxyhash</A></B></CODE> |
| |
| <BR> |
| container for our VMProxy Objects</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>(package private) <A HREF="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#wrappedContext">wrappedContext</A></B></CODE> |
| |
| <BR> |
| context that we are wrapping</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/VMContext.html#VMContext(org.apache.velocity.context.InternalContextAdapter, org.apache.velocity.runtime.RuntimeServices)">VMContext</A></B>(<A HREF="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</A> inner, |
| <A HREF="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</A> rsvc)</CODE> |
| |
| <BR> |
| CTOR, wraps an ICA</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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#addVMProxyArg(org.apache.velocity.runtime.directive.VMProxyArg)">addVMProxyArg</A></B>(<A HREF="../../../../org/apache/velocity/runtime/directive/VMProxyArg.html">VMProxyArg</A> vmpa)</CODE> |
| |
| <BR> |
| Used to put VMProxyArgs into this context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#attachEventCartridge(org.apache.velocity.app.event.EventCartridge)">attachEventCartridge</A></B>(<A HREF="../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</A> ec)</CODE> |
| |
| <BR> |
| </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/VMContext.html#containsKey(java.lang.Object)">containsKey</A></B>(java.lang.Object key)</CODE> |
| |
| <BR> |
| not yet impl</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/VMContext.html#get(java.lang.String)">get</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| Impl of the Context.gut() method.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#getBaseContext()">getBaseContext</A></B>()</CODE> |
| |
| <BR> |
| returns the base full context impl</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#getCurrentResource()">getCurrentResource</A></B>()</CODE> |
| |
| <BR> |
| temporary fix to enable #include() to figure out |
| current encoding.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#getCurrentTemplateName()">getCurrentTemplateName</A></B>()</CODE> |
| |
| <BR> |
| get the current template name</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#getEventCartridge()">getEventCartridge</A></B>()</CODE> |
| |
| <BR> |
| </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/VMContext.html#getInternalUserContext()">getInternalUserContext</A></B>()</CODE> |
| |
| <BR> |
| return the inner / user 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/VMContext.html#getKeys()">getKeys</A></B>()</CODE> |
| |
| <BR> |
| impl badly</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/VMContext.html#getTemplateNameStack()">getTemplateNameStack</A></B>()</CODE> |
| |
| <BR> |
| Returns the template name stack in form of an array.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/velocity/util/introspection/IntrospectionCacheData.html">IntrospectionCacheData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/context/VMContext.html#icacheGet(java.lang.Object)">icacheGet</A></B>(java.lang.Object key)</CODE> |
| |
| <BR> |
| returns an IntrospectionCache Data (@see IntrospectionCacheData) |
| object if exists for the key</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/velocity/context/VMContext.html#icachePut(java.lang.Object, org.apache.velocity.util.introspection.IntrospectionCacheData)">icachePut</A></B>(java.lang.Object key, |
| <A HREF="../../../../org/apache/velocity/util/introspection/IntrospectionCacheData.html">IntrospectionCacheData</A> o)</CODE> |
| |
| <BR> |
| places an IntrospectionCache Data (@see IntrospectionCacheData) |
| element in the cache for specified key</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/velocity/context/VMContext.html#popCurrentTemplateName()">popCurrentTemplateName</A></B>()</CODE> |
| |
| <BR> |
| remove the current template name from stack</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/velocity/context/VMContext.html#pushCurrentTemplateName(java.lang.String)">pushCurrentTemplateName</A></B>(java.lang.String s)</CODE> |
| |
| <BR> |
| set the current template name on top of stack</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/VMContext.html#put(java.lang.String, java.lang.Object)">put</A></B>(java.lang.String key, |
| java.lang.Object value)</CODE> |
| |
| <BR> |
| Impl of the Context.put() method.</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/VMContext.html#remove(java.lang.Object)">remove</A></B>(java.lang.Object key)</CODE> |
| |
| <BR> |
| impl badly</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/velocity/context/VMContext.html#setCurrentResource(org.apache.velocity.runtime.resource.Resource)">setCurrentResource</A></B>(<A HREF="../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</A> r)</CODE> |
| |
| <BR> |
| </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="vmproxyhash"><!-- --></A><H3> |
| vmproxyhash</H3> |
| <PRE> |
| java.util.HashMap <B>vmproxyhash</B></PRE> |
| <DL> |
| <DD>container for our VMProxy Objects</DL> |
| <HR> |
| |
| <A NAME="localcontext"><!-- --></A><H3> |
| localcontext</H3> |
| <PRE> |
| java.util.HashMap <B>localcontext</B></PRE> |
| <DL> |
| <DD>container for any local or constant VMProxy items</DL> |
| <HR> |
| |
| <A NAME="innerContext"><!-- --></A><H3> |
| innerContext</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</A> <B>innerContext</B></PRE> |
| <DL> |
| <DD>the base context store. This is the 'global' context</DL> |
| <HR> |
| |
| <A NAME="wrappedContext"><!-- --></A><H3> |
| wrappedContext</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</A> <B>wrappedContext</B></PRE> |
| <DL> |
| <DD>context that we are wrapping</DL> |
| <HR> |
| |
| <A NAME="localcontextscope"><!-- --></A><H3> |
| localcontextscope</H3> |
| <PRE> |
| private boolean <B>localcontextscope</B></PRE> |
| <DL> |
| <DD>support for local context scope feature, where all references are local</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="VMContext(org.apache.velocity.context.InternalContextAdapter, org.apache.velocity.runtime.RuntimeServices)"><!-- --></A><H3> |
| VMContext</H3> |
| <PRE> |
| public <B>VMContext</B>(<A HREF="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</A> inner, |
| <A HREF="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</A> rsvc)</PRE> |
| <DL> |
| <DD>CTOR, wraps an ICA</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="getInternalUserContext()"><!-- --></A><H3> |
| getInternalUserContext</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/velocity/context/Context.html">Context</A> <B>getInternalUserContext</B>()</PRE> |
| <DL> |
| <DD>return the inner / user context<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalWrapperContext.html#getInternalUserContext()">getInternalUserContext</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalWrapperContext.html">InternalWrapperContext</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBaseContext()"><!-- --></A><H3> |
| getBaseContext</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/velocity/context/InternalContextAdapter.html">InternalContextAdapter</A> <B>getBaseContext</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/velocity/context/InternalWrapperContext.html">InternalWrapperContext</A></CODE></B></DD> |
| <DD>returns the base full context impl<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalWrapperContext.html#getBaseContext()">getBaseContext</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalWrapperContext.html">InternalWrapperContext</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addVMProxyArg(org.apache.velocity.runtime.directive.VMProxyArg)"><!-- --></A><H3> |
| addVMProxyArg</H3> |
| <PRE> |
| public void <B>addVMProxyArg</B>(<A HREF="../../../../org/apache/velocity/runtime/directive/VMProxyArg.html">VMProxyArg</A> vmpa)</PRE> |
| <DL> |
| <DD>Used to put VMProxyArgs into this context. It separates |
| the VMProxyArgs into constant and non-constant types |
| pulling out the value of the constant types so they can |
| be modified w/o damaging the VMProxyArg, and leaving the |
| dynamic ones, as they modify context rather than their own |
| state<DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>vmpa</CODE> - VMProxyArg to add</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>Impl of the Context.put() method.<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> - name of item to set<DD><CODE>value</CODE> - object to set to key<DT><B>Returns:</B><DD>old stored object</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>Impl of the Context.gut() method.<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> - name of item to get<DT><B>Returns:</B><DD>stored object or 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>not yet impl<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>Following copied from interface: <CODE>org.apache.velocity.context.Context</CODE></DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The key to look for.<DT><B>Returns:</B><DD>Whether the key is in the context.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKeys()"><!-- --></A><H3> |
| getKeys</H3> |
| <PRE> |
| public java.lang.Object[] <B>getKeys</B>()</PRE> |
| <DL> |
| <DD>impl badly<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> |
| </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>impl badly<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>Following copied from interface: <CODE>org.apache.velocity.context.Context</CODE></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="pushCurrentTemplateName(java.lang.String)"><!-- --></A><H3> |
| pushCurrentTemplateName</H3> |
| <PRE> |
| public void <B>pushCurrentTemplateName</B>(java.lang.String s)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></B></DD> |
| <DD>set the current template name on top of stack<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html#pushCurrentTemplateName(java.lang.String)">pushCurrentTemplateName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></DL> |
| </DD> |
| <DD>Following copied from interface: <CODE>org.apache.velocity.context.InternalHousekeepingContext</CODE></DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>s</CODE> - current template name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="popCurrentTemplateName()"><!-- --></A><H3> |
| popCurrentTemplateName</H3> |
| <PRE> |
| public void <B>popCurrentTemplateName</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></B></DD> |
| <DD>remove the current template name from stack<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html#popCurrentTemplateName()">popCurrentTemplateName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCurrentTemplateName()"><!-- --></A><H3> |
| getCurrentTemplateName</H3> |
| <PRE> |
| public java.lang.String <B>getCurrentTemplateName</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></B></DD> |
| <DD>get the current template name<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html#getCurrentTemplateName()">getCurrentTemplateName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></DL> |
| </DD> |
| <DD>Following copied from interface: <CODE>org.apache.velocity.context.InternalHousekeepingContext</CODE></DD> |
| <DD><DL> |
| <DT><B>Returns:</B><DD>String current template name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTemplateNameStack()"><!-- --></A><H3> |
| getTemplateNameStack</H3> |
| <PRE> |
| public java.lang.Object[] <B>getTemplateNameStack</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></B></DD> |
| <DD>Returns the template name stack in form of an array.<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html#getTemplateNameStack()">getTemplateNameStack</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></DL> |
| </DD> |
| <DD>Following copied from interface: <CODE>org.apache.velocity.context.InternalHousekeepingContext</CODE></DD> |
| <DD><DL> |
| <DT><B>Returns:</B><DD>Object[] with the template name stack contents.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="icacheGet(java.lang.Object)"><!-- --></A><H3> |
| icacheGet</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/velocity/util/introspection/IntrospectionCacheData.html">IntrospectionCacheData</A> <B>icacheGet</B>(java.lang.Object key)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></B></DD> |
| <DD>returns an IntrospectionCache Data (@see IntrospectionCacheData) |
| object if exists for the key<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html#icacheGet(java.lang.Object)">icacheGet</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></DL> |
| </DD> |
| <DD>Following copied from interface: <CODE>org.apache.velocity.context.InternalHousekeepingContext</CODE></DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - key to find in cache<DT><B>Returns:</B><DD>cache object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="icachePut(java.lang.Object, org.apache.velocity.util.introspection.IntrospectionCacheData)"><!-- --></A><H3> |
| icachePut</H3> |
| <PRE> |
| public void <B>icachePut</B>(java.lang.Object key, |
| <A HREF="../../../../org/apache/velocity/util/introspection/IntrospectionCacheData.html">IntrospectionCacheData</A> o)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></B></DD> |
| <DD>places an IntrospectionCache Data (@see IntrospectionCacheData) |
| element in the cache for specified key<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html#icachePut(java.lang.Object, org.apache.velocity.util.introspection.IntrospectionCacheData)">icachePut</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></DL> |
| </DD> |
| <DD>Following copied from interface: <CODE>org.apache.velocity.context.InternalHousekeepingContext</CODE></DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - key<DD><CODE>o</CODE> - IntrospectionCacheData object to place in cache</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="attachEventCartridge(org.apache.velocity.app.event.EventCartridge)"><!-- --></A><H3> |
| attachEventCartridge</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</A> <B>attachEventCartridge</B>(<A HREF="../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</A> ec)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalEventContext.html#attachEventCartridge(org.apache.velocity.app.event.EventCartridge)">attachEventCartridge</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalEventContext.html">InternalEventContext</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEventCartridge()"><!-- --></A><H3> |
| getEventCartridge</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</A> <B>getEventCartridge</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalEventContext.html#getEventCartridge()">getEventCartridge</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalEventContext.html">InternalEventContext</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCurrentResource(org.apache.velocity.runtime.resource.Resource)"><!-- --></A><H3> |
| setCurrentResource</H3> |
| <PRE> |
| public void <B>setCurrentResource</B>(<A HREF="../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</A> r)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html#setCurrentResource(org.apache.velocity.runtime.resource.Resource)">setCurrentResource</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCurrentResource()"><!-- --></A><H3> |
| getCurrentResource</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</A> <B>getCurrentResource</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></B></DD> |
| <DD>temporary fix to enable #include() to figure out |
| current encoding.<DD><DL> |
| <DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html#getCurrentResource()">getCurrentResource</A></CODE> in interface <CODE><A HREF="../../../../org/apache/velocity/context/InternalHousekeepingContext.html">InternalHousekeepingContext</A></CODE></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/VMContext.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/velocity/context/InternalContextBase.html"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="VMContext.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> |
