Package be.gaudry.model.disposition

Enum Class EPageCounterFormat

java.lang.Object

java.lang.Enum<EPageCounterFormat>

be.gaudry.model.disposition.EPageCounterFormat

All Implemented Interfaces:

Serializable, Comparable<EPageCounterFormat>, Constable

public enum EPageCounterFormat
extends Enum<EPageCounterFormat>

Possibles representations of a page numbering format. Provided by the broldev.core.model project.

Since:

1.0 Jul 2, 2008, broldev.core.model 0.0.1-SNAPSHOT dependency

Version:

1.0 Jul 2, 2008

Author:

Steph GAUDRY

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
X_DE_Y	x de y
X_MINUS_Y	x-y
X_OF_Y	x of y
X_SLASH_Y	x/y

Method Summary

Modifier and Type	Method	Description
static EPageCounterFormat	fromInt(int key)
int	getValue()	The value is a numeric representation of this EPageCounterFormat, independent of the Enum.ordinal() information.
String	toString()	String representation of this instance, to display.
static EPageCounterFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EPageCounterFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

X_DE_Y

public static final EPageCounterFormat X_DE_Y

x de y

X_OF_Y

public static final EPageCounterFormat X_OF_Y

x of y

X_SLASH_Y

public static final EPageCounterFormat X_SLASH_Y

x/y

X_MINUS_Y

public static final EPageCounterFormat X_MINUS_Y

x-y

Method Details

values

public static EPageCounterFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EPageCounterFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

The value is a numeric representation of this EPageCounterFormat, independent of the Enum.ordinal() information.

Returns:

the value

toString

public String toString()

String representation of this instance, to display.

Overrides:

toString in class Enum<EPageCounterFormat>

fromInt

public static EPageCounterFormat fromInt(int key)

Parameters:

key - numeric representation of the EPageCounterFormat,value given by the getValue() method.

Returns:

the matching EPageCounterFormat, or X_DE_Y in case of wrong parameter