KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ibatis > sqlmap > engine > scope > Scope


1 /*
2  * Copyright 2004 Clinton Begin
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */

16 package com.ibatis.sqlmap.engine.scope;
17
18 /**
19  * An interface to simplify access to different scopes (contexts?)
20  */

21 public interface Scope {
22
23   /**
24    * Gets a named object out of the scope
25    *
26    * @param key - the name of the object to get
27    * @return the object
28    */

29   public Object JavaDoc getAttribute(Object JavaDoc key);
30
31   /**
32    * Puts a named value into the scope
33    *
34    * @param key - the name of the object to put
35    * @param value - the value to associate with that name
36    */

37   public void setAttribute(Object JavaDoc key, Object JavaDoc value);
38
39   /**
40    * Clears all data out of the scope
41    */

42   public void reset();
43
44 }
45
Popular Tags