Package analyzer

Enum Class Comment.Type

java.lang.Object

java.lang.Enum<Comment.Type>

analyzer.Comment.Type

All Implemented Interfaces:

Serializable, Comparable<Comment.Type>, Constable

Enclosing class:

Comment

public static enum Comment.Type
extends Enum<Comment.Type>

The type of comment. Note that the order defined here corresponds to the order in which comments are sorted in the analyzer output.

See Also:

• Documentation on comment types

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
ACTIONABLE
CELEBRATORY
ESSENTIAL
INFORMATIVE

Method Summary

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

ESSENTIAL

public static final Comment.Type ESSENTIAL

ACTIONABLE

public static final Comment.Type ACTIONABLE

INFORMATIVE

public static final Comment.Type INFORMATIVE

CELEBRATORY

public static final Comment.Type CELEBRATORY

Method Details

values

public static Comment.Type[] 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 Comment.Type 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