Package org.java.plugin.tools.mocks
Class MockDocumentation<T extends Identity>
- java.lang.Object
-
- org.java.plugin.tools.mocks.MockDocumentation<T>
-
- Type Parameters:
T- documentation owner element type
- All Implemented Interfaces:
Documentation<T>
public class MockDocumentation<T extends Identity> extends java.lang.Object implements Documentation<T>
- Version:
- $Id$
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.java.plugin.registry.Documentation
Documentation.Reference<E extends Identity>
-
-
Constructor Summary
Constructors Constructor Description MockDocumentation()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MockDocumentation<T>addReference(Documentation.Reference<T> reference)java.lang.StringgetCaption()TgetDeclaringIdentity()java.util.Collection<Documentation.Reference<T>>getReferences()java.lang.StringgetText()MockDocumentation<T>setCaption(java.lang.String value)MockDocumentation<T>setDeclaringIdentity(T value)MockDocumentation<T>setText(java.lang.String value)
-
-
-
Method Detail
-
getCaption
public java.lang.String getCaption()
- Specified by:
getCaptionin interfaceDocumentation<T extends Identity>- Returns:
- plug-in element caption or empty string
- See Also:
Documentation.getCaption()
-
setCaption
public MockDocumentation<T> setCaption(java.lang.String value)
- Parameters:
value- the caption to set- Returns:
- this instance
-
getDeclaringIdentity
public T getDeclaringIdentity()
- Specified by:
getDeclaringIdentityin interfaceDocumentation<T extends Identity>- Returns:
- element, for which this documentation is provided
- See Also:
Documentation.getDeclaringIdentity()
-
setDeclaringIdentity
public MockDocumentation<T> setDeclaringIdentity(T value)
- Parameters:
value- the declaring identity to set- Returns:
- this instance
-
getReferences
public java.util.Collection<Documentation.Reference<T>> getReferences()
- Specified by:
getReferencesin interfaceDocumentation<T extends Identity>- Returns:
- collection of
referencesin this documentation - See Also:
Documentation.getReferences()
-
addReference
public MockDocumentation<T> addReference(Documentation.Reference<T> reference)
- Parameters:
reference- reference to add- Returns:
- this instance
-
getText
public java.lang.String getText()
- Specified by:
getTextin interfaceDocumentation<T extends Identity>- Returns:
- main documentation text or empty string
- See Also:
Documentation.getText()
-
setText
public MockDocumentation<T> setText(java.lang.String value)
- Parameters:
value- the text to set- Returns:
- this instance
-
-