1 /***
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $Id: IContext.java,v 1.5 2005/09/14 18:50:05 mat007 Exp $
29 */
30
31 package jtge.engine.data;
32
33 /***
34 * Defines a container of data.
35 *
36 * @author Mathieu Champlon
37 * @version $Revision: 1.5 $ $Date: 2005/09/14 18:50:05 $
38 */
39 public interface IContext
40 {
41 /***
42 * Add a data to the context.
43 *
44 * @param key the data unique identifier
45 * @param data the data
46 */
47 void put( Object key, Object data );
48
49 /***
50 * Retrieve a data based on its identifier.
51 *
52 * @param key the data unique identifier
53 * @return the data
54 */
55 Object get( Object key );
56
57 /***
58 * Register a callback.
59 * <p>
60 * Any update( Type data ) method of this object will be called when the type of its data argument is compatible
61 * with the type of a data set by calling the set() method.
62 *
63 * @param callback a callback
64 */
65 void register( Object callback );
66 }