KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*====================================================================
2
3 Objectweb Browser Framework
4 Copyright (C) 2000-2003 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): Philippe Merle, Jerome Moroy.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.util.browser.api;
28
29 /**
30  * Entries are non-mutable structures representing entries in contexts.
31  *
32  * An Entry is composed of a <code>&lt;name,value,context&gt;</code> tuple,
33  * where name is an Object, value is an Object and
34  * context is the owner Context.
35  *
36  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>,
37  * <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>
38  *
39  * @version 0.2
40  *
41  */
42 public interface Entry
43 {
44
45     /**
46      * Gets the value contained in the entry.
47      *
48      * This method does not update the value contained in the entry.
49      *
50      * @return The value contained in the entry.
51      */
52     public Object JavaDoc
53     getValue();
54
55     /**
56      * Gets the name of the entry.
57      *
58      * This method does not update the name of the entry.
59      *
60      * @return The name of the target entry, in the context it belongs to.
61      *
62      */
63     public Object JavaDoc
64     getName();
65
66     /**
67      * Gets the context containing the entry,
68      * if any, null otherwise.
69      *
70      * This method does not update the context containing
71      * the entry.
72      *
73      * @return The context containing the entry,
74      * if any, null otherwise.
75      *
76      */
77     public Context
78     getContext();
79
80 }
Popular Tags