com.thomasjensen.checkstyle.addons.checks.regexp

Enum RegexpOnFilenameOption

java.lang.Object

java.lang.Enum<RegexpOnFilenameOption>

com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnFilenameOption

All Implemented Interfaces:

Serializable, Comparable<RegexpOnFilenameOption>

public enum RegexpOnFilenameOption
extends Enum<RegexpOnFilenameOption>

Represents the possible modes of operation for the RegexpOnFilenameCheck.

Author:

Thomas Jensen

Enum Constant Summary

Enum Constants

Enum Constant and Description
ILLEGAL In ILLEGAL mode, the regular expression must not match the filename, and a violation is logged if the regexp matched anyway.
REQUIRED In REQUIRED mode, the regular expression must match the filename, and a violation is logged if the regexp does not match.

Method Summary

Methods

Modifier and Type	Method and Description
static RegexpOnFilenameOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static RegexpOnFilenameOption	valueOfIgnoreCase(String pValue) Variant of Enum.valueOf(java.lang.Class<T>, java.lang.String) that ignores value case.
static RegexpOnFilenameOption[]	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

REQUIRED

public static final RegexpOnFilenameOption REQUIRED

In REQUIRED mode, the regular expression must match the filename, and a violation is logged if the regexp does not match.

ILLEGAL

public static final RegexpOnFilenameOption ILLEGAL

In ILLEGAL mode, the regular expression must not match the filename, and a violation is logged if the regexp matched anyway.

Method Detail

values

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

Returns:

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

valueOf

public static RegexpOnFilenameOption 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

valueOfIgnoreCase

@Nonnull
public static RegexpOnFilenameOption valueOfIgnoreCase(@Nonnull
                                               String pValue)

Variant of Enum.valueOf(java.lang.Class<T>, java.lang.String) that ignores value case.

Parameters:

pValue - the String value

Returns:

the enum value

Throws:

IllegalArgumentException - the given String value does not match a valid enum value