geirm 01/01/02 21:16:43 Added: src/java/org/apache/velocity/context InternalContext.java Log: Internal context interface. Revision Changes Path 1.1 jakarta-velocity/src/java/org/apache/velocity/context/InternalContext.java Index: InternalContext.java =================================================================== package org.apache.velocity.context; /* * The Apache Software License, Version 1.1 * * Copyright (c) 2000 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, if * any, must include the following acknowlegement: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowlegement may appear in the software itself, * if and wherever such third-party acknowlegements normally appear. * * 4. The names "The Jakarta Project", "Velocity", and "Apache Software * Foundation" must not be used to endorse or promote products derived * from this software without prior written permission. For written * permission, please contact [EMAIL PROTECTED] * * 5. Products derived from this software may not be called "Apache" * nor may "Apache" appear in their names without prior written * permission of the Apache Group. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. */ import org.apache.velocity.util.introspection.IntrospectionCacheData; /** * interface to encapsulate the 'stuff' for internal operation of velocity. * We use the context as a thread-safe storage : we take advantage of the * fact that it's a visitor of sorts to all nodes (that matter) of the * AST during init() and render(). * * Currently, it carries the template name for namespace * support, as well as node-local context data introspection caching. * * @author <a href="mailto:[EMAIL PROTECTED]">Geir Magnusson Jr.</a> * @version $Id: InternalContext.java,v 1.1 2001/01/03 05:16:43 geirm Exp $ */ interface InternalContext { /** * set the current template name * * @param s current template name to set */ void setCurrentTemplateName( String s ); /** * get the current template name * * @return String current template name */ String getCurrentTemplateName(); /** * returns an IntrospectionCache Data (@see IntrospectionCacheData) * object if exists for the key * * @param key key to find in cache * @return cache object */ IntrospectionCacheData icacheGet( Object key ); /** * places an IntrospectionCache Data (@see IntrospectionCacheData) * element in the cache for specified key * * @param key key * @param o IntrospectionCacheData object to place in cache */ void icachePut( Object key, IntrospectionCacheData o ); }
