1 package org.apache.velocity.context;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "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 /**
31 * Returns the wrapped user context.
32 * @return The wrapped user context.
33 */
34 Context getInternalUserContext();
35
36 /**
37 * Returns the base full context impl.
38 * @return The base full context impl.
39 *
40 */
41 InternalContextAdapter getBaseContext();
42
43 /**
44 * Allows callers to explicitly put objects in the local context.
45 * Objects added to the context through this method always end up
46 * in the top-level context of possible wrapped contexts.
47 *
48 * @param key name of item to set.
49 * @param value object to set to key.
50 * @return old stored object
51 */
52 Object localPut(final String key, final Object value);
53 }