KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > api > Entry


1 /*====================================================================
2
3 Objectweb Explorer Framework
4 Copyright (C) 2000-2004 INRIA - USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Jerome Moroy, Philippe Merle.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.util.explorer.api;
28
29 import java.io.Serializable JavaDoc;
30
31 /**
32  * Entries are non-mutable structures representing entries in contexts.
33  *
34  * An Entry is composed of a <code>&lt;name,valuet&gt;</code> tuple,
35  * where name is an Object, value is an Object.
36  *
37  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>,
38  * <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>
39  *
40  * @version 0.3
41  *
42  */
43 public interface Entry
44          extends Serializable JavaDoc
45 {
46
47     /**
48      * Fixes the name of the entry.
49      *
50      * This method updates the name of the entry.
51      *
52      * @param value The name of the target entry.
53      *
54      */
55     public void
56     setName(Object JavaDoc value);
57     
58     /**
59      * Gets the name of the entry.
60      *
61      * This method does not update the name of the entry.
62      *
63      * @return The name of the target entry, in the context it belongs to.
64      *
65      */
66     public Object JavaDoc
67     getName();
68     
69     /**
70      * Fixes the value contained in the entry.
71      *
72      * This method updates the value contained in the entry.
73      *
74      * @param value The value contained in the entry.
75      */
76     public void
77     setValue(Object JavaDoc value);
78         
79     /**
80      * Gets the value contained in the entry.
81      *
82      * This method does not update the value contained in the entry.
83      *
84      * @return The value contained in the entry.
85      */
86     public Object JavaDoc
87     getValue();
88
89     /**
90      * Fixes the wrapper of the value contained in the entry.
91      *
92      * This method updates the value contained in the entry.
93      *
94      * @param value
95      */
96     public void
97     setWrapper(Context value);
98     
99     /**
100      * Gets the wrapper of the value contained in the entry.
101      *
102      * This method does not update the value contained in the entry.
103      *
104      * @return The value contained in the entry.
105      */
106     public Context
107     getWrapper();
108     
109     
110 }
Popular Tags