wt.vc
Class VersionIdentifier

java.lang.Object
  wt.vc.VersionIdentifier

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable

public class VersionIdentifier
extends Object
implements ObjectMappable, Externalizable

An identifier that uniquely labels a version.

Use the newVersionIdentifier static factory method(s), not the VersionIdentifier 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

MultilevelSeries	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(MultilevelSeries value) Supports initialization, following construction of an instance.
static VersionIdentifier	newVersionIdentifier() Construct a VersionIdentifier.
static VersionIdentifier	newVersionIdentifier(MultilevelSeries value) Construct a VersionIdentifier using a series.

Methods inherited from class java.lang.Object

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

Method Detail

newVersionIdentifier

public static VersionIdentifier newVersionIdentifier()
                                              throws WTException

Construct a VersionIdentifier.

Supported API: true

Returns:

VersionIdentifier

Throws:

WTException

newVersionIdentifier

public static VersionIdentifier newVersionIdentifier(MultilevelSeries value)
                                              throws WTException

Construct a VersionIdentifier using a series.

Supported API: true

Parameters:

value -

Returns:

VersionIdentifier

Throws:

WTException

getSeries

public MultilevelSeries getSeries()
                           throws VersionControlException

Gets the series.

Returns:

MultilevelSeries

Throws:

VersionControlException

getValue

public String getValue()

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

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(MultilevelSeries 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