wt.vc
Class IterationIdentifier

java.lang.Object
  wt.vc.IterationIdentifier

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable

public class IterationIdentifier
extends Object
implements ObjectMappable, Externalizable

An identifier that uniquely labels an iteration.

Use the newIterationIdentifier static factory method(s), not the IterationIdentifier 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:

Serialized Form

Method Summary

Series	getSeries() Gets the Series.
String	getValue() Gets the aggregated series' value and returns it as a string.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(Series value) Supports initialization, following construction of an instance.
protected void	initialize(String number) Supports initialization, following construction of an instance.
static IterationIdentifier	newIterationIdentifier() Constructs an IterationIdentifier.
static IterationIdentifier	newIterationIdentifier(Series value) Constructs an IterationIdentifier using a Series.
static IterationIdentifier	newIterationIdentifier(String number) Constructs an IterationIdentifier using a String.

Methods inherited from class java.lang.Object

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

Method Detail

newIterationIdentifier

public static IterationIdentifier newIterationIdentifier()
                                                  throws WTException

Constructs an IterationIdentifier.

Supported API: true

Returns:

IterationIdentifier

Throws:

WTException

newIterationIdentifier

public static IterationIdentifier newIterationIdentifier(Series value)
                                                  throws WTException

Constructs an IterationIdentifier using a Series.

Supported API: true

Parameters:

value -

Returns:

IterationIdentifier

Throws:

WTException

getSeries

public Series getSeries()
                 throws VersionControlException

Gets the Series.

Supported API: true

Returns:

Series

Throws:

VersionControlException

getValue

public String getValue()

Gets the aggregated series' value and returns it as a string.

Supported API: true

Returns:

String

initialize

protected void initialize()
                   throws WTException

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

Supported API: true

Throws:

WTException

initialize

protected void initialize(Series value)
                   throws WTException

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

Supported API: true

Parameters:

value -

Throws:

WTException

newIterationIdentifier

public static IterationIdentifier newIterationIdentifier(String number)
                                                  throws WTException

Constructs an IterationIdentifier using a String.

Supported API: true

Parameters:

number -

Returns:

IterationIdentifier

Throws:

WTException

initialize

protected void initialize(String number)
                   throws WTException

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

Supported API: true

Parameters:

number -

Throws:

WTException