com.whitestein.lsps.lang.doc

Class DocText

java.lang.Object

com.whitestein.lsps.lang.doc.DocText

public class DocText
extends Object

A documentation text. The documentation text consists of a simple text as well as inline tags, such as {@code} or {@link ...}. The documentation text is then represented as a sequence of these text elements.

Author:

jsa

See Also:

DocTextElement, asPlainText()

Constructor Summary

Constructors

Constructor and Description
DocText(List<DocTextElement> elements) Constructs a new documentation text which consists of a sequence of the given text elements.

Method Summary

Modifier and Type	Method and Description
String	asPlainText() Returns a representation of this documentation text as plain text without any special formatting.
List<DocTextElement>	getElements() Returns an unmodifiable list of elements which compose this documentation text.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocText

public DocText(List<DocTextElement> elements)

Constructs a new documentation text which consists of a sequence of the given text elements.

Parameters:

elements - a sequence of the text elements

Method Detail

asPlainText

public String asPlainText()

Returns a representation of this documentation text as plain text without any special formatting.

Returns:

a plain text representation of this documentation text

getElements

public List<DocTextElement> getElements()

Returns an unmodifiable list of elements which compose this documentation text.

Returns:

a list text elements

toString

public String toString()

Overrides:

toString in class Object