1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
/*****************************************************************************
* Java Plug-in Framework (JPF)
* Copyright (C) 2004-2007 Dmitry Olshansky
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*****************************************************************************/
package org.java.plugin.registry;
import java.util.Collection;
/**
* Interface to collect documentation data for some plug-in element.
* @param <T> type of identity this documentation belongs to
* @version $Id$
*/
public interface Documentation<T extends Identity> {
/**
* @return plug-in element caption or empty string
*/
String getCaption();
/**
* @return main documentation text or empty string
*/
String getText();
/**
* @return collection of {@link Reference references} in this documentation
*/
Collection<Reference<T>> getReferences();
/**
* @return element, for which this documentation is provided
*/
T getDeclaringIdentity();
/**
* Documentation reference.
* @param <E> type of identity this documentation reference belongs to
* @version $Id$
*/
interface Reference<E extends Identity> {
/**
* @return the reference as specified in manifest
*/
String getRef();
/**
* @return text to be used when making link for this reference
*/
String getCaption();
/**
* @return element, for which this documentation reference is provided
*/
E getDeclaringIdentity();
}
}
|
