Enum JavadocTagInfo.Type
- java.lang.Object
-
- java.lang.Enum<JavadocTagInfo.Type>
-
- com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagInfo.Type
-
- All Implemented Interfaces:
Serializable
,Comparable<JavadocTagInfo.Type>
- Enclosing class:
- JavadocTagInfo
public static enum JavadocTagInfo.Type extends Enum<JavadocTagInfo.Type>
The Javadoc Type.For example a
@param
tag is a block tag while a{@link}
tag is an inline tag.
-
-
Constructor Summary
Constructors Modifier Constructor Description private
Type()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static JavadocTagInfo.Type
valueOf(String name)
Returns the enum constant of this type with the specified name.static JavadocTagInfo.Type[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
BLOCK
public static final JavadocTagInfo.Type BLOCK
Block type.
-
INLINE
public static final JavadocTagInfo.Type INLINE
Inline type.
-
-
Constructor Detail
-
Type
private Type()
-
-
Method Detail
-
values
public static JavadocTagInfo.Type[] 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 (JavadocTagInfo.Type c : JavadocTagInfo.Type.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static JavadocTagInfo.Type valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-