Interface CodeDoc

All Superinterfaces:

CodeItem, CodeMergeableItem<CodeDoc>, CodeMutable, CodeMutableItem, CodeNode, CodeNodeItem, CodeNodeItemCopyable<CodeElement, CodeDoc>, CodeSimpleMergeableItem<CodeDoc>, CodeWithContext

public interface CodeDoc
extends CodeSimpleMergeableItem<CodeDoc>, CodeNodeItemCopyable<CodeElement, CodeDoc>

CodeItem representing API documentation (e.g. JavaDoc or JSDoc). Please read documentation of getLines() before using.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	NO_LINES	Empty lines.
static final String	TAG_CODE	Doc tag for a code format.
static final String	TAG_LINK	Doc tag for a link.
static final String	TAG_LINKPLAIN	Doc tag for a plain link.
static final String	TAG_LITERAL	Doc tag for an un-escaped literal.
static final String	TAG_PARAM	Tag for the documentation of the parameter of a function.
static final String	TAG_RETURN	Tag for the documentation of returned result of a function.
static final String	TAG_THROWS	Tag for the documentation of an exception.
static final String	TAG_VALUE	Doc tag for a value reference.

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
void	add(String... lines)	Please read documentation of getLines() before using.
void	add(Collection<String> lines)	Please read documentation of getLines() before using.
default String	getFormatted(CodeDocFormat format)
String	getFormatted(CodeDocFormat format, String newline)
List<String>	getLines()	Attention: Child elements such as CodeParameters, CodeExceptions, CodeReturn, and CodeTypeVariables hold their specific CodeDoc that is not included in the CodeDoc of their parent CodeOperation or CodeType.
default String[]	getLinesAsArray()
boolean	isEmpty()

Methods inherited from interface CodeItem

getLanguage, getSourceCode, write, write, write, write, write, write

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

getReflectiveObject, setImmutable

Methods inherited from interface CodeNodeItemCopyable

copy, copy, getParent

Methods inherited from interface CodeSimpleMergeableItem

merge, merge

Methods inherited from interface CodeWithContext

getContext, getSource

Field Details

TAG_PARAM

static final String TAG_PARAM

Tag for the documentation of the parameter of a function. This tag will be invisible via this API as the according doc is accessed via the according CodeParameter.

See Also:

• Constant Field Values

TAG_THROWS

static final String TAG_THROWS

Tag for the documentation of an exception. This tag will be invisible via this API as the according doc is accessed via the according CodeException.

See Also:

• Constant Field Values

TAG_RETURN

static final String TAG_RETURN

Tag for the documentation of returned result of a function. This tag will be invisible via this API as the according doc is accessed via the according CodeReturn.

See Also:

• Constant Field Values

TAG_LINK

static final String TAG_LINK

Doc tag for a link.

See Also:

• Constant Field Values

TAG_LINKPLAIN

static final String TAG_LINKPLAIN

Doc tag for a plain link.

See Also:

• Constant Field Values

TAG_CODE

static final String TAG_CODE

Doc tag for a code format.

See Also:

• Constant Field Values

TAG_LITERAL

static final String TAG_LITERAL

Doc tag for an un-escaped literal.

See Also:

• Constant Field Values

TAG_VALUE

static final String TAG_VALUE

Doc tag for a value reference.

See Also:

• Constant Field Values

NO_LINES

static final String[] NO_LINES

Empty lines.

Method Details

getFormatted

default String getFormatted(CodeDocFormat format)

Parameters:

format - the requested CodeDocFormat.

Returns:

this documentation as String in the given CodeDocFormat. Will be the empty String if not available and therefore never null.

getFormatted

String getFormatted(CodeDocFormat format,
 String newline)

Parameters:

format - the requested CodeDocFormat.

newline - the newline String.

Returns:

this documentation as String in the given CodeDocFormat. Will be the empty String if not available and therefore never null.

getLines

List<String> getLines()

Attention: Child elements such as CodeParameters, CodeExceptions, CodeReturn, and CodeTypeVariables hold their specific CodeDoc that is not included in the CodeDoc of their parent CodeOperation or CodeType. Therefore you shall not see or add any lines with tags such as "@param", "@throws", or "@return". These will only be produced on-the-fly when the source-code is produced.

Returns:

the List with the raw lines of documentation without leading format prefix ("/**", "*", "/*").

getLinesAsArray

default String[] getLinesAsArray()

Returns:

the documentation lines as array.

See Also:

• getLines()

add

void add(Collection<String> lines)

Please read documentation of getLines() before using.

Parameters:

lines - the textual documentation lines to add to getLines().

Throws:

io.github.mmm.base.exception.ReadOnlyException - if immutable.

add

void add(String... lines)

Please read documentation of getLines() before using.

Parameters:

lines - the textual documentation lines to add to getLines().

Throws:

io.github.mmm.base.exception.ReadOnlyException - if immutable.

isEmpty

boolean isEmpty()

Returns:

true if this documentation is empty.