Package org.java.plugin.tools.mocks
Class MockPluginElement<T extends PluginElement<T>>
- java.lang.Object
-
- org.java.plugin.tools.mocks.MockIdentity
-
- org.java.plugin.tools.mocks.MockPluginElement<T>
-
- Type Parameters:
T
- plug-in element owner type
- All Implemented Interfaces:
Documentable<T>
,Identity
,PluginElement<T>
- Direct Known Subclasses:
MockExtension
,MockExtensionPoint
,MockLibrary
,MockParameter
,MockParameterDefinition
,MockPluginAttribute
,MockPluginPrerequisite
public abstract class MockPluginElement<T extends PluginElement<T>> extends MockIdentity implements PluginElement<T>
- Version:
- $Id$
-
-
Constructor Summary
Constructors Constructor Description MockPluginElement()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PluginDescriptor
getDeclaringPluginDescriptor()
Returns plug-in descriptor, this element belongs to.PluginFragment
getDeclaringPluginFragment()
Returns descriptor of plug-in fragment that contributes this element.java.lang.String
getDocsPath()
Documentation<T>
getDocumentation()
MockPluginElement<T>
setDeclaringPluginDescriptor(PluginDescriptor value)
MockPluginElement<T>
setDeclaringPluginFragment(PluginFragment value)
MockPluginElement<T>
setDocsPath(java.lang.String value)
MockPluginElement<T>
setDocumentation(Documentation<T> value)
-
Methods inherited from class org.java.plugin.tools.mocks.MockIdentity
getId, setId
-
-
-
-
Method Detail
-
getDeclaringPluginDescriptor
public PluginDescriptor getDeclaringPluginDescriptor()
Description copied from interface:PluginElement
Returns plug-in descriptor, this element belongs to. This method should never returnnull
.- Specified by:
getDeclaringPluginDescriptor
in interfacePluginElement<T extends PluginElement<T>>
- Returns:
- plug-in descriptor, this element belongs to
- See Also:
PluginElement.getDeclaringPluginDescriptor()
-
setDeclaringPluginDescriptor
public MockPluginElement<T> setDeclaringPluginDescriptor(PluginDescriptor value)
- Parameters:
value
- the declaring plug-in descriptor to set- Returns:
- this instance
-
getDeclaringPluginFragment
public PluginFragment getDeclaringPluginFragment()
Description copied from interface:PluginElement
Returns descriptor of plug-in fragment that contributes this element. This method may returnnull
, if element is contributed by plug-in directly.- Specified by:
getDeclaringPluginFragment
in interfacePluginElement<T extends PluginElement<T>>
- Returns:
- descriptor of plug-in fragment that contributes this element
- See Also:
PluginElement.getDeclaringPluginFragment()
-
setDeclaringPluginFragment
public MockPluginElement<T> setDeclaringPluginFragment(PluginFragment value)
- Parameters:
value
- the declaring plug-in fragment to set- Returns:
- this instance
-
getDocsPath
public java.lang.String getDocsPath()
- Specified by:
getDocsPath
in interfaceDocumentable<T extends PluginElement<T>>
- Returns:
- path to documentation "home", it is used for resolving documentation references
- See Also:
Documentable.getDocsPath()
-
setDocsPath
public MockPluginElement<T> setDocsPath(java.lang.String value)
- Parameters:
value
- the docs path to set- Returns:
- this instance
-
getDocumentation
public Documentation<T> getDocumentation()
- Specified by:
getDocumentation
in interfaceDocumentable<T extends PluginElement<T>>
- Returns:
- plug-in element documentation object or
null
if there is no documentation provided - See Also:
Documentable.getDocumentation()
-
setDocumentation
public MockPluginElement<T> setDocumentation(Documentation<T> value)
- Parameters:
value
- the documentation to set- Returns:
- this instance
-
-