Package org.java.plugin.registry
Interface Documentation<T extends Identity>
-
- Type Parameters:
T
- type of identity this documentation belongs to
- All Known Implementing Classes:
MockDocumentation
public interface Documentation<T extends Identity>
Interface to collect documentation data for some plug-in element.- Version:
- $Id$
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Documentation.Reference<E extends Identity>
Documentation reference.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getCaption()
T
getDeclaringIdentity()
java.util.Collection<Documentation.Reference<T>>
getReferences()
java.lang.String
getText()
-
-
-
Method Detail
-
getCaption
java.lang.String getCaption()
- Returns:
- plug-in element caption or empty string
-
getText
java.lang.String getText()
- Returns:
- main documentation text or empty string
-
getReferences
java.util.Collection<Documentation.Reference<T>> getReferences()
- Returns:
- collection of
references
in this documentation
-
getDeclaringIdentity
T getDeclaringIdentity()
- Returns:
- element, for which this documentation is provided
-
-