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

MockDocumentation()

Method Summary

MockDocumentation<T>	addReference(Documentation.Reference<T> reference)
java.lang.String	getCaption()
T	getDeclaringIdentity()
java.util.Collection<Documentation.Reference<T>>	getReferences()
java.lang.String	getText()
MockDocumentation<T>	setCaption(java.lang.String value)
MockDocumentation<T>	setDeclaringIdentity(T value)
MockDocumentation<T>	setText(java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MockDocumentation

public MockDocumentation()

Method Detail

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface Documentation<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:

getDeclaringIdentity in interface Documentation<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:

getReferences in interface Documentation<T extends Identity>

Returns:

collection of references in 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:

getText in interface Documentation<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