Package org.ysb33r.ysf.projects.core.documentation

Enum Class DocumentationType

java.lang.Object

java.lang.Enum<DocumentationType>

org.ysb33r.ysf.projects.core.documentation.DocumentationType

All Implemented Interfaces:

Serializable, Comparable<DocumentationType>, Constable

public enum DocumentationType
extends Enum<DocumentationType>

Documentation type

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASCIIDOC	Asciidoc files.
BUILT_API_DOCS_HTML	Content is HTML that has been created by another task.
RAW_GROOVY_SOURCE	Raw Groovy (and Java) source code.

Method Summary

Modifier and Type	Method	Description
final String	getAntoraLinkType()	Antora link type.
final String	getAntoraType()	Type of Antora documentation.
static DocumentationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentationType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BUILT_API_DOCS_HTML

public static final DocumentationType BUILT_API_DOCS_HTML

Content is HTML that has been created by another task.

RAW_GROOVY_SOURCE

public static final DocumentationType RAW_GROOVY_SOURCE

Raw Groovy (and Java) source code.

ASCIIDOC

public static final DocumentationType ASCIIDOC

Asciidoc files.

Method Details

values

public static DocumentationType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DocumentationType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getAntoraType

public final String getAntoraType()

Type of Antora documentation.

Returns:

Antora family directory string

getAntoraLinkType

public final String getAntoraLinkType()

Antora link type.

Returns:

xref or link.