package bboss.org.apache.velocity.context;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
import bboss.org.apache.velocity.app.event.EventCartridge;
import bboss.org.apache.velocity.runtime.resource.Resource;
import bboss.org.apache.velocity.util.introspection.IntrospectionCacheData;
/**
* This is an abstract internal-use-only context implementation to be
* used as a subclass for other internal-use-only contexts that wrap
* other internal-use-only contexts.
*
* We use this context to make it easier to chain an existing context
* as part of a new context implementation. It just delegates everything
* to the inner/parent context. Subclasses then only need to override
* the methods relevant to them.
*
* @author Nathan Bubna
* @version $Id: ChainedInternalContextAdapter.java 685724 2008-08-13 23:12:12Z nbubna $
* @since 1.6
*/
public abstract class ChainedInternalContextAdapter implements InternalContextAdapter
{
/** the parent context */
protected InternalContextAdapter innerContext = null;
/**
* CTOR, wraps an ICA
* @param inner context
*/
public ChainedInternalContextAdapter(InternalContextAdapter inner)
{
innerContext = inner;
}
/**
* Return the inner / user context.
* @return The inner / user context.
*/
public Context getInternalUserContext()
{
return innerContext.getInternalUserContext();
}
/**
* @see bboss.org.apache.velocity.context.InternalWrapperContext#getBaseContext()
*/
public InternalContextAdapter getBaseContext()
{
return innerContext.getBaseContext();
}
/**
* Retrieves from parent context.
*
* @param key name of item to get
* @return stored object or null
*/
public Object get(String key)
{
return innerContext.get(key);
}
/**
* Put method also stores values in parent context
*
* @param key name of item to set
* @param value object to set to key
* @return old stored object
*/
public Object put(String key, Object value)
{
/*
* just put in the local context
*/
return innerContext.put(key, value);
}
/**
* @see bboss.org.apache.velocity.context.Context#containsKey(java.lang.Object)
*/
public boolean containsKey(Object key)
{
return innerContext.containsKey(key);
}
/**
* @see bboss.org.apache.velocity.context.Context#getKeys()
*/
public Object[] getKeys()
{
return innerContext.getKeys();
}
/**
* @see bboss.org.apache.velocity.context.Context#remove(java.lang.Object)
*/
public Object remove(Object key)
{
return innerContext.remove(key);
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#pushCurrentTemplateName(java.lang.String)
*/
public void pushCurrentTemplateName(String s)
{
innerContext.pushCurrentTemplateName(s);
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#popCurrentTemplateName()
*/
public void popCurrentTemplateName()
{
innerContext.popCurrentTemplateName();
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#getCurrentTemplateName()
*/
public String getCurrentTemplateName()
{
return innerContext.getCurrentTemplateName();
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#getTemplateNameStack()
*/
public Object[] getTemplateNameStack()
{
return innerContext.getTemplateNameStack();
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#pushCurrentMacroName(java.lang.String)
*/
public void pushCurrentMacroName(String s)
{
innerContext.pushCurrentMacroName(s);
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#popCurrentMacroName()
*/
public void popCurrentMacroName()
{
innerContext.popCurrentMacroName();
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#getCurrentMacroName()
*/
public String getCurrentMacroName()
{
return innerContext.getCurrentMacroName();
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#getCurrentMacroCallDepth()
*/
public int getCurrentMacroCallDepth()
{
return innerContext.getCurrentMacroCallDepth();
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#getMacroNameStack()
*/
public Object[] getMacroNameStack()
{
return innerContext.getMacroNameStack();
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#icacheGet(java.lang.Object)
*/
public IntrospectionCacheData icacheGet(Object key)
{
return innerContext.icacheGet(key);
}
/**
* @see bboss.org.apache.velocity.context.InternalWrapperContext#localPut(java.lang.String,java.lang.Object)
*/
public Object localPut(final String key, final Object value)
{
return innerContext.put(key, value);
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#icachePut(java.lang.Object, bboss.org.apache.velocity.util.introspection.IntrospectionCacheData)
*/
public void icachePut(Object key, IntrospectionCacheData o)
{
innerContext.icachePut(key, o);
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#setMacroLibraries(List)
*/
public void setMacroLibraries(List macroLibraries)
{
innerContext.setMacroLibraries(macroLibraries);
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#getMacroLibraries()
*/
public List getMacroLibraries()
{
return innerContext.getMacroLibraries();
}
/**
* @see bboss.org.apache.velocity.context.InternalEventContext#attachEventCartridge(bboss.org.apache.velocity.app.event.EventCartridge)
*/
public EventCartridge attachEventCartridge(EventCartridge ec)
{
return innerContext.attachEventCartridge(ec);
}
/**
* @see bboss.org.apache.velocity.context.InternalEventContext#getEventCartridge()
*/
public EventCartridge getEventCartridge()
{
return innerContext.getEventCartridge();
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#setCurrentResource(bboss.org.apache.velocity.runtime.resource.Resource)
*/
public void setCurrentResource(Resource r)
{
innerContext.setCurrentResource(r);
}
/**
* @see bboss.org.apache.velocity.context.InternalHousekeepingContext#getCurrentResource()
*/
public Resource getCurrentResource()
{
return innerContext.getCurrentResource();
}
}