Package org.openrewrite.gradle.attributes

Enum Class DocsType

java.lang.Object

java.lang.Enum<DocsType>

org.openrewrite.gradle.attributes.DocsType

All Implemented Interfaces:

Serializable, Comparable<DocsType>, Constable, org.openrewrite.maven.attributes.Attribute

public enum DocsType
extends Enum<DocsType>
implements org.openrewrite.maven.attributes.Attribute

See Gradle javadocs for org.gradle.api.attributes.DocsType

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
DOXYGEN	The typical documentation for native APIs
JAVADOC	The typical documentation for Java APIs
SAMPLES	Samples illustrating how to use the software module
SOURCES	The source files of the module
USER_MANUAL	A user manual

Method Summary

Modifier and Type	Method	Description
static @Nullable DocsType	from(@Nullable String docsType)
static String	key()
static DocsType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocsType[]	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

JAVADOC

public static final DocsType JAVADOC

The typical documentation for Java APIs

SOURCES

public static final DocsType SOURCES

The source files of the module

USER_MANUAL

public static final DocsType USER_MANUAL

A user manual

SAMPLES

public static final DocsType SAMPLES

Samples illustrating how to use the software module

DOXYGEN

public static final DocsType DOXYGEN

The typical documentation for native APIs

Method Details

values

public static DocsType[] 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 DocsType 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

key

public static String key()

from

public static @Nullable DocsType from(@Nullable String docsType)