KickJava   Java API By Example, From Geeks To Geeks.

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


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): Philippe Merle, Jerome Moroy.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.util.explorer.api;
28
29 /**
30  * <p>
31  * This class allows to provide short information about an object.<br>
32  * In order to configure this element, you can have a look to the corresponding
33  * <a HREF="explorer-dtd.html#info">DTD element</a> or to
34  * an <a HREF="package-summary.html#xml">XML example.</a>
35  * </p>
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.1
41  */
42 public interface Info
43 {
44
45     /**
46      * Return a <code>String</code> representing data on the given object.
47      *
48      * @param treeView A view on the tree.
49      *
50      * @return Data representing the given object;
51      */
52     public String JavaDoc
53     getInfo(TreeView treeView);
54
55 }
Popular Tags