com.puppycrawl.tools.checkstyle

Enum PropertyType

java.lang.Object

java.lang.Enum<PropertyType>

com.puppycrawl.tools.checkstyle.PropertyType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PropertyType>

public enum PropertyType
extends java.lang.Enum<PropertyType>

Represents the custom property type used in documentation and configuration files.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILE This property is a file.
LOCALE_COUNTRY This property is a string represents an ISO 3166 2-letter code.
LOCALE_LANGUAGE This property is a string represents an ISO 639 code.
PATTERN This property is a regular expression pattern.
STRING This property is a string.
TOKEN_ARRAY This property is a set of tokens.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	description The human-readable property description.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the human-readable property description.
static PropertyType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PropertyType[]	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

FILE

public static final PropertyType FILE

This property is a file.

LOCALE_COUNTRY

public static final PropertyType LOCALE_COUNTRY

This property is a string represents an ISO 3166 2-letter code.

LOCALE_LANGUAGE

public static final PropertyType LOCALE_LANGUAGE

This property is a string represents an ISO 639 code.

PATTERN

public static final PropertyType PATTERN

This property is a regular expression pattern.

STRING

public static final PropertyType STRING

This property is a string.

TOKEN_ARRAY

public static final PropertyType TOKEN_ARRAY

This property is a set of tokens.

Field Detail

description

private final java.lang.String description

The human-readable property description.

Method Detail

values

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

Returns:

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

valueOf

public static PropertyType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDescription

public java.lang.String getDescription()

Returns the human-readable property description.

Returns:

human-readable property description