com.izforge.izpack.panels.userinput.field.rule
Enum RuleFormat

java.lang.Object
  java.lang.Enum<RuleFormat>
      com.izforge.izpack.panels.userinput.field.rule.RuleFormat

All Implemented Interfaces:

Serializable, Comparable<RuleFormat>

public enum RuleFormat
extends Enum<RuleFormat>

Describes the format of an RuleField.

Author:

Tim Anderson

Enum Constant Summary

DISPLAY_FORMAT
Specifies to return the contents of all fields together with all separators as specified in the field format concatenated into one long string.

PLAIN_STRING
Specifies to return the contents of all fields concatenated into one long string, with separation between each component.

PROCESSED
Specifies to return the contents of all fields using an Processor.

SPECIAL_SEPARATOR
Specifies to return the contents of all fields concatenated into one long string, with a special separator string inserted in between the individual components.

Method Summary

static RuleFormat	fromString(String value) Returns a RuleFormat for the specified value.
String	toString() Returns a string representation of this.
static RuleFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static RuleFormat[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLAIN_STRING

public static final RuleFormat PLAIN_STRING

Specifies to return the contents of all fields concatenated into one long string, with separation between each component.

DISPLAY_FORMAT

public static final RuleFormat DISPLAY_FORMAT

Specifies to return the contents of all fields together with all separators as specified in the field format concatenated into one long string. In this case the resulting string looks just like the user saw it during data entry.

SPECIAL_SEPARATOR

public static final RuleFormat SPECIAL_SEPARATOR

Specifies to return the contents of all fields concatenated into one long string, with a special separator string inserted in between the individual components.

PROCESSED

public static final RuleFormat PROCESSED

Specifies to return the contents of all fields using an Processor.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Returns a string representation of this.

Overrides:

toString in class Enum<RuleFormat>

Returns:

the format

fromString

public static RuleFormat fromString(String value)

Returns a RuleFormat for the specified value.

Parameters:

value - the value

Returns:

the corresponding RuleFormat, or null if none is found