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$ 27 */ 28 public interface InternalWrapperContext 29 { 30 31 /** 32 * Returns the wrapped user context. 33 * @return The wrapped user context. 34 */ getInternalUserContext()35 Context getInternalUserContext(); 36 37 /** 38 * Returns the base full context impl. 39 * @return The base full context impl. 40 * 41 */ getBaseContext()42 InternalContextAdapter getBaseContext(); 43 44 /** 45 * Place a key value pair into the context. 46 * @param key 47 * @param value 48 * @return previous value 49 */ put(String key, Object value)50 Object put(String key, Object value); 51 52 /** 53 * Retrieve the specified valuefrom the given key. 54 * @param key 55 * @return found value 56 */ get(String key)57 Object get(String key); 58 59 /** 60 * Tests if the key exists in the specified scope 61 * @param key 62 * @return true if key exists 63 */ containsKey(String key)64 boolean containsKey(String key); 65 66 } 67