Class CodeDocFormat

java.lang.Object

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

Direct Known Subclasses:

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

public abstract class CodeDocFormat
extends Object

Definition of format(s) to be able to convert CodeDoc to.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

• CodeDoc.getFormatted(CodeDocFormat)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CodeDocFormat.CodeDocFormatAsciiDoc	CodeDocFormat for ASCII_DOC.
protected static class	CodeDocFormat.CodeDocFormatHtml	CodeDocFormat for HTML.
protected static class	CodeDocFormat.CodeDocFormatPlainText	CodeDocFormat for PLAIN_TEXT.
protected static class	CodeDocFormat.CodeDocFormatRaw	CodeDocFormat for RAW.

Field Summary

Fields

Modifier and Type	Field	Description
static final CodeDocFormat	ASCII_DOC	CodeDocFormat for documentation as AsciiDoc fragment.
static final CodeDocFormat	HTML	CodeDocFormat for documentation as HTML fragment.
static final CodeDocFormat	PLAIN_TEXT	CodeDocFormat for documentation as plain text (all markup removed).
static final CodeDocFormat	RAW	CodeDocFormat for documentation as raw text in its original source format (e.g.

Constructor Summary

Constructors

Constructor	Description
CodeDocFormat()

Method Summary

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

Methods inherited from class Object

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

Field Details

HTML

public static final CodeDocFormat HTML

CodeDocFormat for documentation as HTML fragment.

ASCII_DOC

public static final CodeDocFormat ASCII_DOC

CodeDocFormat for documentation as AsciiDoc fragment.

PLAIN_TEXT

public static final CodeDocFormat PLAIN_TEXT

CodeDocFormat for documentation as plain text (all markup removed).

RAW

public static final CodeDocFormat RAW

CodeDocFormat for documentation as raw text in its original source format (e.g. JavaDoc or JSDoc).

Constructor Details

CodeDocFormat

public CodeDocFormat()

Method Details

isReplaceXmlTags

public abstract boolean isReplaceXmlTags()

Returns:

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

replaceXmlTag

public abstract String replaceXmlTag(Tag tag)

Parameters:

tag - the XML Tag to replace.

Returns:

the replacement.

replaceDocTag

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

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 abstract String toString()

Overrides:

toString in class Object