Package org.apache.fop.fo.properties

Class EnumProperty

java.lang.Object

org.apache.fop.fo.properties.Property

org.apache.fop.fo.properties.EnumProperty

public final class EnumProperty
extends Property

Superclass for properties that wrap an enumeration value

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnumProperty.Maker	Inner class for creating EnumProperty instances

Field Summary

Fields

Modifier and Type	Field	Description
private static PropertyCache<EnumProperty>	CACHE	cache holding all canonical EnumProperty instances
private java.lang.String	text
private int	value

Fields inherited from class org.apache.fop.fo.properties.Property

log

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EnumProperty(int explicitValue, java.lang.String text)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
int	getEnum()	This method expects to be overridden by subclasses
static EnumProperty	getInstance(int explicitValue, java.lang.String text)	Construct an enumeration property.
java.lang.Object	getObject()	This method expects to be overridden by subclasses
int	hashCode()

Methods inherited from class org.apache.fop.fo.properties.Property

getCharacter, getColor, getCondLength, getKeep, getLength, getLengthPair, getLengthRange, getList, getNCname, getNumber, getNumeric, getSpace, getSpecifiedValue, getString, isAuto, setSpecifiedValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CACHE

private static final PropertyCache<EnumProperty> CACHE

cache holding all canonical EnumProperty instances

value

private final int value

text

private final java.lang.String text

Constructor Detail

EnumProperty

private EnumProperty(int explicitValue,
                     java.lang.String text)

Parameters:

explicitValue - enumerated value to be set for this property

text - the string value of the enum.

Method Detail

getInstance

public static EnumProperty getInstance(int explicitValue,
                                       java.lang.String text)

Construct an enumeration property.

Parameters:

explicitValue - the value

text - the text

Returns:

an enumeration property

getEnum

public int getEnum()

Description copied from class: Property

This method expects to be overridden by subclasses

Overrides:

getEnum in class Property

Returns:

this.value

getObject

public java.lang.Object getObject()

Description copied from class: Property

This method expects to be overridden by subclasses

Overrides:

getObject in class Property

Returns:

this.value cast as an Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object