KickJava   Java API By Example, From Geeks To Geeks.

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


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  * <p>
31  * A wrapper owns a reference to a wrapped object.<br>
32  * In order to define a panel, you can have a look to the corresponding
33  * <a HREF="../../../../../../resources/browser_dtd.html#wrapper">DTD element</a> or to
34  * an <a HREF="package-summary.html#xml">XML example.</a>
35  * </p>
36  *
37  * <p>
38  * Example:
39  * <pre>
40  * public void
41  * setWrapped(Object object)
42  * {
43  * properties_ = (Properties) object;
44  * }
45  *
46  * public Object
47  * getWrapped()
48  * {
49  * return properties_;
50  * }
51  * </pre>
52  * The wrapper manages <code>java.util.Properties<code> object.
53  * </p>
54  *
55  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>,
56  * <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>
57  *
58  * @version 0.2
59  */
60 public interface Wrapper
61 {
62
63     /**
64      * Sets the wrapped object.
65      *
66      * @param object The object to wrap.
67      */
68     public void
69     setWrapped(Object JavaDoc object);
70
71     /**
72      * Gets the wrapped object.
73      *
74      * @return The wrapped object.
75      */
76     public Object JavaDoc
77     getWrapped();
78
79 }
Popular Tags