01: package org.apache.velocity.context;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "License"); you may not use this file except in compliance
10: * with the License. You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing,
15: * software distributed under the License is distributed on an
16: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17: * KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations
19: * under the License.
20: */
21:
22: /**
23: * interface for internal context wrapping functionality
24: *
25: * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
26: * @version $Id: InternalWrapperContext.java 471908 2006-11-06 22:39:28Z henning $
27: */
28: public interface InternalWrapperContext {
29: /**
30: * Returns the wrapped user context.
31: * @return The wrapped user context.
32: */
33: Context getInternalUserContext();
34:
35: /**
36: * Returns the base full context impl.
37: * @return The base full context impl.
38: *
39: */
40: InternalContextAdapter getBaseContext();
41:
42: /**
43: * Allows callers to explicitly put objects in the local context.
44: * Objects added to the context through this method always end up
45: * in the top-level context of possible wrapped contexts.
46: *
47: * @param key name of item to set.
48: * @param value object to set to key.
49: * @return old stored object
50: */
51: Object localPut(final String key, final Object value);
52: }
|