Enum Class JavadocSeeTagOrderCheck.Category
java.lang.Object
java.lang.Enum<JavadocSeeTagOrderCheck.Category>
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocSeeTagOrderCheck.Category
- All Implemented Interfaces:
Serializable,Comparable<JavadocSeeTagOrderCheck.Category>,Constable
- Enclosing class:
JavadocSeeTagOrderCheck
Category of a
@see reference, ordered from the closest to the most distant access.-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionLocal member such as#fieldor#method().Package reference such asjava.util.Qualified type member such asjava.util.List#size().Qualified type reference such asjava.util.List.Simple type member such asOtherClass#field.Simple type reference such asOtherClass. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final intExplicit structural order, independent of the enum's declaration order. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) intorder()Returns the explicit structural order.Returns the enum constant of this class with the specified name.static JavadocSeeTagOrderCheck.Category[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
LOCAL
Local member such as#fieldor#method(). -
SIMPLE_TYPE
Simple type reference such asOtherClass. -
SIMPLE_MEMBER
Simple type member such asOtherClass#field. -
QUALIFIED_TYPE
Qualified type reference such asjava.util.List. -
QUALIFIED_MEMBER
Qualified type member such asjava.util.List#size(). -
PACKAGE
Package reference such asjava.util.
-
-
Field Details
-
structuralOrder
private final int structuralOrderExplicit structural order, independent of the enum's declaration order.
-
-
Constructor Details
-
Category
private Category(int order) Creates a newCategoryinstance.- Parameters:
order- the explicit structural order
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
order
int order()Returns the explicit structural order.- Returns:
- the structural order
-