Class CodeDocFormat.CodeDocFormatPlainText

java.lang.Object

io.github.mmm.code.api.doc.CodeDocFormat

io.github.mmm.code.api.doc.CodeDocFormat.CodeDocFormatPlainText

Enclosing class:

CodeDocFormat

protected static class CodeDocFormat.CodeDocFormatPlainText
extends CodeDocFormat

CodeDocFormat for CodeDocFormat.PLAIN_TEXT.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from class CodeDocFormat

CodeDocFormat.CodeDocFormatAsciiDoc, CodeDocFormat.CodeDocFormatHtml, CodeDocFormat.CodeDocFormatPlainText, CodeDocFormat.CodeDocFormatRaw

Field Summary

Fields inherited from class CodeDocFormat

ASCII_DOC, HTML, PLAIN_TEXT, RAW

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CodeDocFormatPlainText()

Method Summary

Modifier and Type	Method	Description
boolean	isReplaceXmlTags()
String	replaceDocTag(String tag, Supplier<CodeDocLink> link, String text)
String	replaceXmlTag(Tag tag)
String	toString()

Methods inherited from class Object

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

Constructor Details

CodeDocFormatPlainText

protected CodeDocFormatPlainText()

Method Details

isReplaceXmlTags

public boolean isReplaceXmlTags()

Specified by:

isReplaceXmlTags in class CodeDocFormat

Returns:

true if XML tags shall be parsed and replaced, false otherwise (if they shall be kept unmodified).

replaceXmlTag

public String replaceXmlTag(Tag tag)

Specified by:

replaceXmlTag in class CodeDocFormat

Parameters:

tag - the XML Tag to replace.

Returns:

the replacement.

replaceDocTag

public String replaceDocTag(String tag,
 Supplier<CodeDocLink> link,
 String text)

Specified by:

replaceDocTag in class CodeDocFormat

Parameters:

tag - the documentation tag such as CodeDoc.TAG_CODE or CodeDoc.TAG_LINK.

link - the optional Supplier used to resolve a CodeDocLink in case of link, linkplain, or value tag. Otherwise null.

text - the plain text.

Returns:

the tag converted to this format.

toString

public String toString()

Specified by:

toString in class CodeDocFormat