wt.vc
Class OneOffVersionIdentifier

java.lang.Object
  wt.vc.OneOffVersionIdentifier

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable

public class OneOffVersionIdentifier
extends Object
implements ObjectMappable, Externalizable

An identifier that uniquely labels a One Off Version.

Use the newOneOffVersionIdentifier static factory method(s), not the OneOffVersionIdentifier 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.
static OneOffVersionIdentifier	newOneOffVersionIdentifier() Constructs a OneOffVersionIdentifier.
static OneOffVersionIdentifier	newOneOffVersionIdentifier(Series value) Constructs a OneOffVersionIdentifier using a Series.

Methods inherited from class java.lang.Object

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

Method Detail

newOneOffVersionIdentifier

public static OneOffVersionIdentifier newOneOffVersionIdentifier()
                                                          throws WTException

Constructs a OneOffVersionIdentifier.

Supported API: true

Returns:

OneOffVersionIdentifier

Throws:

WTException

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

newOneOffVersionIdentifier

public static OneOffVersionIdentifier newOneOffVersionIdentifier(Series value)
                                                          throws WTException

Constructs a OneOffVersionIdentifier using a Series.

Supported API: true

Parameters:

value -

Returns:

OneOffVersionIdentifier

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

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