com.puppycrawl.tools.checkstyle.filters

Enum SuppressionCommentFilter.TagType

java.lang.Object

java.lang.Enum<SuppressionCommentFilter.TagType>

com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.TagType

All Implemented Interfaces:

Serializable, Comparable<SuppressionCommentFilter.TagType>

Enclosing class:

SuppressionCommentFilter

public static enum SuppressionCommentFilter.TagType
extends Enum<SuppressionCommentFilter.TagType>

Enum to be used for switching checkstyle reporting for tags.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OFF Switch reporting off.
ON Switch reporting on.

Method Summary

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

Enum Constant Detail

ON

public static final SuppressionCommentFilter.TagType ON

Switch reporting on.

OFF

public static final SuppressionCommentFilter.TagType OFF

Switch reporting off.

Method Detail

values

public static SuppressionCommentFilter.TagType[] 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 (SuppressionCommentFilter.TagType c : SuppressionCommentFilter.TagType.values())
    System.out.println(c);

Returns:

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

valueOf

public static SuppressionCommentFilter.TagType 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 name

NullPointerException - if the argument is null