io.spine.tools.gradle

Enum JavadocPrettifierTaskName

java.lang.Object

java.lang.Enum<JavadocPrettifierTaskName>

io.spine.tools.gradle.JavadocPrettifierTaskName

All Implemented Interfaces:

TaskName, java.io.Serializable, java.lang.Comparable<JavadocPrettifierTaskName>

@Internal
public enum JavadocPrettifierTaskName
extends java.lang.Enum<JavadocPrettifierTaskName>
implements TaskName

Names of Gradle tasks defined by the Javadoc Prettifier plugin.

Enum Constant Summary

Enum Constants

Enum Constant and Description
formatProtoDoc Formats the Javadoc in sources generated from .proto files in the main scope.
formatTestProtoDoc Formats the Javadoc in sources generated from .proto files in the test scope.

Method Summary

Modifier and Type	Method and Description
static JavadocPrettifierTaskName	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JavadocPrettifierTaskName[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.spine.tools.gradle.TaskName

name, path

Enum Constant Detail

formatProtoDoc

public static final JavadocPrettifierTaskName formatProtoDoc

Formats the Javadoc in sources generated from .proto files in the main scope.

formatTestProtoDoc

public static final JavadocPrettifierTaskName formatTestProtoDoc

Formats the Javadoc in sources generated from .proto files in the test scope.

Method Detail

values

public static JavadocPrettifierTaskName[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JavadocPrettifierTaskName c : JavadocPrettifierTaskName.values())
    System.out.println(c);

Returns:

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

valueOf

public static JavadocPrettifierTaskName valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null