KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > java > plugin > registry > Documentation


1 /*****************************************************************************
2  * Java Plug-in Framework (JPF)
3  * Copyright (C) 2004-2005 Dmitry Olshansky
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *****************************************************************************/

19 package org.java.plugin.registry;
20
21 import java.util.Collection JavaDoc;
22
23 /**
24  * Interface to collect documentation data for some plug-in element.
25  * @version $Id: Documentation.java,v 1.1 2005/07/20 18:43:46 ddimon Exp $
26  */

27 public interface Documentation {
28     /**
29      * @return plug-in element caption or empty string
30      */

31     String JavaDoc getCaption();
32     
33     /**
34      * @return main documentation text or empty string
35      */

36     String JavaDoc getText();
37     
38     /**
39      * @return collection of {@link Reference references} in this documentation
40      */

41     Collection JavaDoc getReferences();
42     
43     /**
44      * @return element, for which this documentation is provided
45      */

46     Identity getDeclaringIdentity();
47     
48     /**
49      * Documentation reference.
50      * @version $Id: Documentation.java,v 1.1 2005/07/20 18:43:46 ddimon Exp $
51      */

52     interface Reference {
53         /**
54          * @return the reference as specified in manifest
55          */

56         String JavaDoc getRef();
57         
58         /**
59          * @return text to be used when making link for this reference
60          */

61         String JavaDoc getCaption();
62         
63         /**
64          * @return element, for which this documentation reference is provided
65          */

66         Identity getDeclaringIdentity();
67     }
68 }
69
Popular Tags