Package com.puppycrawl.tools.checkstyle.checks.javadoc

Enum Class JavadocSeeTagOrderCheck.Kind

java.lang.Object

java.lang.Enum<JavadocSeeTagOrderCheck.Kind>

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocSeeTagOrderCheck.Kind

All Implemented Interfaces:

Serializable, Comparable<JavadocSeeTagOrderCheck.Kind>, Constable

Enclosing class:

JavadocSeeTagOrderCheck

private static enum JavadocSeeTagOrderCheck.Kind
extends Enum<JavadocSeeTagOrderCheck.Kind>

Kind of a member @see reference, ordered from the closest to the most distant access. Type and package references are not members and are always classified as METHOD, since that kind never needs to be compared against another kind within their own category.

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
CONSTRUCTOR	A constructor reference such as #Example().
FIELD	A field reference such as #field.
METHOD	A method or type/package reference such as #getName().

Field Summary

Fields

Modifier and Type	Field	Description
private final int	structuralOrder	Explicit structural order, independent of the enum's declaration order.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Kind(int order)	Creates a new Kind instance.

Method Summary

Modifier and Type	Method	Description
(package private) int	order()	Returns the explicit structural order.
static JavadocSeeTagOrderCheck.Kind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JavadocSeeTagOrderCheck.Kind[]	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

FIELD

public static final JavadocSeeTagOrderCheck.Kind FIELD

A field reference such as #field.

CONSTRUCTOR

public static final JavadocSeeTagOrderCheck.Kind CONSTRUCTOR

A constructor reference such as #Example().

METHOD

public static final JavadocSeeTagOrderCheck.Kind METHOD

A method or type/package reference such as #getName().

Field Details

structuralOrder

private final int structuralOrder

Explicit structural order, independent of the enum's declaration order.

Constructor Details

Kind

private Kind(int order)

Creates a new Kind instance.

Parameters:

order - the explicit structural order

Method Details

values

public static JavadocSeeTagOrderCheck.Kind[] 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 JavadocSeeTagOrderCheck.Kind 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

order

int order()

Returns the explicit structural order.

Returns:

the structural order