wt.eff
Class StringEffRange

java.lang.Object
  wt.eff.StringEffRange

All Implemented Interfaces:

Externalizable, Serializable, EffRange, NetFactor, ObjectMappable

public class StringEffRange
extends Object
implements EffRange, Externalizable

A range using Strings which are not left filled. This is the range used by UnitEffectivity, and does not left-fill: 9 > 10. To ensure proper behavior, all values should have the same number of characters.

Use the newStringEffRange static factory method(s), not the StringEffRange constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

UnitEffectivity, Serialized Form

Field Summary

static String	END Label for the attribute; The end value, constrained as a String.
static String	START Label for the attribute; The start value, constrained as a String.

Method Summary

Serializable	getEnd() Gets the value of the attribute: END.
Serializable	getStart() Gets the value of the attribute: START.
protected void	initialize(String startValue) Supports initialization, following construction of an instance.
protected void	initialize(String startValue, String endValue) Supports initialization, following construction of an instance.
static StringEffRange	newStringEffRange(String startValue) Factory which sets the start value.
static StringEffRange	newStringEffRange(String startValue, String endValue) Factory which sets the start and end value Supported API: true
void	setEnd(Serializable a_End) Sets the value of the attribute: END.
void	setStart(Serializable a_Start) Sets the value of the attribute: START.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

START

public static final String START

Label for the attribute; The start value, constrained as a String.

Supported API: true

See Also:

Constant Field Values

END

public static final String END

Label for the attribute; The end value, constrained as a String.

Supported API: true

See Also:

Constant Field Values

Method Detail

getStart

public Serializable getStart()

Gets the value of the attribute: START. The start value, constrained as a String.

Supported API: true

Specified by:

getStart in interface EffRange

Returns:

Serializable

setStart

public void setStart(Serializable a_Start)
              throws WTPropertyVetoException

Sets the value of the attribute: START. The start value, constrained as a String.

Supported API: true

Specified by:

setStart in interface EffRange

Parameters:

a_Start -

Throws:

WTPropertyVetoException

getEnd

public Serializable getEnd()

Gets the value of the attribute: END. The end value, constrained as a String.

Supported API: true

Specified by:

getEnd in interface EffRange

Returns:

Serializable

setEnd

public void setEnd(Serializable a_End)
            throws WTPropertyVetoException

Sets the value of the attribute: END. The end value, constrained as a String.

Supported API: true

Specified by:

setEnd in interface EffRange

Parameters:

a_End -

Throws:

WTPropertyVetoException

newStringEffRange

public static StringEffRange newStringEffRange(String startValue,
                                               String endValue)
                                        throws WTPropertyVetoException

Factory which sets the start and end value

Supported API: true

Parameters:

startValue -

endValue -

Returns:

StringEffRange

Throws:

WTPropertyVetoException

initialize

protected void initialize(String startValue,
                          String endValue)
                   throws WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

startValue -

endValue -

Throws:

WTPropertyVetoException

newStringEffRange

public static StringEffRange newStringEffRange(String startValue)
                                        throws WTPropertyVetoException

Factory which sets the start value. The end is left null.

Supported API: true

Parameters:

startValue -

Returns:

StringEffRange

Throws:

WTPropertyVetoException

initialize

protected void initialize(String startValue)
                   throws WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

startValue -

Throws:

WTPropertyVetoException