org.axsl.common.value

Enum LeaderPattern

java.lang.Object

java.lang.Enum<LeaderPattern>

org.axsl.common.value.LeaderPattern

All Implemented Interfaces:

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

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

Enumeration of valid leader patterns.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOTS Leader is to be filled with a repeating sequence of dots.
RULE Leader is to be filled with a rule (a line, but not necessarily a solid line).
SPACE Leader is to be filled with blank space.
USE_CONTENT Leader is to be filled with a specified repeating pattern.

Method Summary

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

SPACE

public static final LeaderPattern SPACE

Leader is to be filled with blank space.

RULE

public static final LeaderPattern RULE

Leader is to be filled with a rule (a line, but not necessarily a solid line).

DOTS

public static final LeaderPattern DOTS

Leader is to be filled with a repeating sequence of dots.

USE_CONTENT

public static final LeaderPattern USE_CONTENT

Leader is to be filled with a specified repeating pattern.

Method Detail

values

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

Returns:

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

valueOf

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