Package net.sourceforge.pmd.properties

Enum PropertyDescriptorField

java.lang.Object

java.lang.Enum<PropertyDescriptorField>

net.sourceforge.pmd.properties.PropertyDescriptorField

All Implemented Interfaces:

Serializable, Comparable<PropertyDescriptorField>

@Deprecated
public enum PropertyDescriptorField
extends Enum<PropertyDescriptorField>

Deprecated.

Will be removed with 7.0.0

Field names for parsing the properties out of the ruleset xml files. These are intended to be used as the keys to a map of fields to values. Most property descriptors can be built directly from such a map using their factory.

Author:

Brian Remedios

See Also:

RuleSetFactory, PropertyTypeId

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHOICES	Deprecated. Choices for enumerated properties.
DEFAULT_INDEX	Deprecated. Default index for enumerated properties.
DEFAULT_VALUE	Deprecated. The default value.
DELIMITER	Deprecated. For multi-valued properties, this defines the delimiter of the single values.
DESCRIPTION	Deprecated. The description of the property.
LABELS	Deprecated. Labels for enumerated properties.
LEGAL_PACKAGES	Deprecated. To limit the range of valid values, package names.
MAX	Deprecated. The maximum allowed value for numeric properties.
MIN	Deprecated. The minimum allowed value for numeric properties.
NAME	Deprecated. The name of the property.
TYPE	Deprecated. The type of the property.
UI_ORDER	Deprecated. The UI order.

Method Summary

Modifier and Type	Method	Description
String	attributeName()	Deprecated. Returns the String name of this attribute.
static PropertyDescriptorField	getConstant(String name)	Deprecated.
String	toString()	Deprecated.
static PropertyDescriptorField	valueOf(String name)	Deprecated. Returns the enum constant of this type with the specified name.
static PropertyDescriptorField[]	values()	Deprecated. 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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TYPE

public static final PropertyDescriptorField TYPE

Deprecated.

The type of the property.

NAME

public static final PropertyDescriptorField NAME

Deprecated.

The name of the property.

DESCRIPTION

public static final PropertyDescriptorField DESCRIPTION

Deprecated.

The description of the property.

UI_ORDER

public static final PropertyDescriptorField UI_ORDER

Deprecated.

The UI order.

DEFAULT_VALUE

public static final PropertyDescriptorField DEFAULT_VALUE

Deprecated.

The default value.

DELIMITER

public static final PropertyDescriptorField DELIMITER

Deprecated.

For multi-valued properties, this defines the delimiter of the single values.

MIN

public static final PropertyDescriptorField MIN

Deprecated.

The minimum allowed value for numeric properties.

MAX

public static final PropertyDescriptorField MAX

Deprecated.

The maximum allowed value for numeric properties.

LEGAL_PACKAGES

public static final PropertyDescriptorField LEGAL_PACKAGES

Deprecated.

To limit the range of valid values, package names.

LABELS

public static final PropertyDescriptorField LABELS

Deprecated.

Labels for enumerated properties.

CHOICES

public static final PropertyDescriptorField CHOICES

Deprecated.

Choices for enumerated properties.

DEFAULT_INDEX

public static final PropertyDescriptorField DEFAULT_INDEX

Deprecated.

Default index for enumerated properties.

Method Detail

values

public static PropertyDescriptorField[] values()

Deprecated.

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 (PropertyDescriptorField c : PropertyDescriptorField.values())
    System.out.println(c);

Returns:

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

valueOf

public static PropertyDescriptorField valueOf(String name)

Deprecated.

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

attributeName

public String attributeName()

Deprecated.

Returns the String name of this attribute.

Returns:

The attribute's name

toString

public String toString()

Deprecated.

Overrides:

toString in class Enum<PropertyDescriptorField>

getConstant

public static PropertyDescriptorField getConstant(String name)

Deprecated.