wt.eff.format
Class EffRangeValues

java.lang.Object
  wt.eff.format.EffRangeValues

All Implemented Interfaces:

Serializable

public final class EffRangeValues
extends Object
implements Serializable

A class that represents an immutable Value Object - designed to hold start and end range values of effectivity statements.
Instances of EffRangeValues are designed and treated as immutable, once initialized during construction. Hence they can be safely shared and are thread-safe. As Value Objects, they do not have any conceptual identity of their own and exist primarily to describe attributes of interest to EffFormat instances. Hence, cloning of instances (clone()) is not supported, since they can instead be shared.

Note: Defensive copies are not made, as there is no need to maintain for such strict immutability. Also, sinceequals()hashcode methods are not implemented, two instances of this class are equal, iff all of their corresponding field values are equal. This is important to note, when instances of this class are used in hash based data structures. Finally, cloning of instances is not supported, because they can be efficiently shared instead.


Supported API: true

Extendable: false

Since:

Windchill 9.0

See Also:

EffState, EffFormat, EffFormatService, Serialized Form

Field Summary

String	endValue Holds end of range.
String	startValue Holds start of range.

Constructor Summary

EffRangeValues(String singleRangeValue)
If a single range value is of interest for the use case in hand, this constructor allows construction of such an EffRangeValues instance.

EffRangeValues(String startValue, String endValue)
EffRangeValue's start and end values correspond to values that are not validated yet by the associated EffFormat class.

Method Summary

String	getEndValue() Gets the value of the attribute: endValue; Holds end of range.
String	getStartValue() Gets the value of the attribute: startValue; Holds start of range.

Methods inherited from class java.lang.Object

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

Field Detail

startValue

public final String startValue

Holds start of range.

Supported API: true

endValue

public final String endValue

Holds end of range.

Supported API: true

Constructor Detail

EffRangeValues

public EffRangeValues(String startValue,
                      String endValue)

EffRangeValue's start and end values correspond to values that are not validated yet by the associated EffFormat class. Hence, null and empty strings are valid values for this constructor.

Generally, instances of this class hold an effectivity range that is about to validated or processed by other operations.

Supported API: true

Parameters:

startValue - (Optional) holds start of range.

endValue - (Optional) holds end of range.

EffRangeValues

public EffRangeValues(String singleRangeValue)

If a single range value is of interest for the use case in hand, this constructor allows construction of such an EffRangeValues instance. As an example, while constructing part instances, often just a particular serial/lot number is of importance.

Generally, instances of this class hold an effectivity range that is about to validated or processed by effectivity format related operations.

Supported API: true

Parameters:

singleRangeValue -

Method Detail

getStartValue

public final String getStartValue()

Gets the value of the attribute: startValue; Holds start of range.

Supported API: true

Returns:

String

getEndValue

public final String getEndValue()

Gets the value of the attribute: endValue; Holds end of range.

Supported API: true

Returns:

String