geirm 01/01/02 21:16:24 Added: src/java/org/apache/velocity/context Context.java Log: Application context interface. Revision Changes Path 1.1 jakarta-velocity/src/java/org/apache/velocity/context/Context.java Index: Context.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 java.util.Hashtable; import java.io.Serializable; import org.apache.velocity.util.ArrayIterator; /** * Interface describing the application data context. This set of * routines is used by the application to set and remove 'named' data * object to pass them to the template engine to use when rendering * a template. * * This is the same set of methods supported by the original Context * class * * @see org.apache.velocity.context.AbstractContext * @see org.apache.velocity.VelocityContext * * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> * @author <a href="mailto:[EMAIL PROTECTED]">Geir Magnusson Jr.</a> * @version $Id: Context.java,v 1.1 2001/01/03 05:16:24 geirm Exp $ */ public interface Context { /** * Adds a name/value pair to the context. * * @param key The name to key the provided value with. * @param value The corresponding value. */ public Object put(String key, Object value); /** * Gets the value corresponding to the provided key from the context. * * @param key The name of the desired value. * @return The value corresponding to the provided key. */ public Object get(String key); /** * Indicates whether the specified key is in the context. * * @param key The key to look for. * @return Whether the key is in the context. */ public boolean containsKey(Object key); /** * Get all the keys for the values in the context */ public Object[] getKeys(); /** * Removes the value associated with the specified key from the context. * * @param key The name of the value to remove. * @return The value that the key was mapped to, or <code>null</code> * if unmapped. */ public Object remove(Object key); }
