Package wt.vc

Class IterationIdentifier

java.lang.Object
wt.vc._IterationIdentifier
wt.vc.IterationIdentifier
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable
@GenAsObjectMappable(versions=4215211265623835657L,properties={@GeneratedProperty(name="iterationId",type=java.lang.String.class,javaDoc="An identifier that uniquely labels an iteration. This attribute seems to be duplicative with the \"value\" attribute within the \"identifier\" attribute but is required since the identifier is typed as an abstract class that can\'t be correctly generated for externalization (i.e., the abstract class is all that\'s known at the time of generation to apply as the class for constructing a new instance). <P> For this [duplicative] declaration to work the \"identifier\" must be specified as not persistent. Its accessors must handle the translations between it and this id. And there must be no accessors generated for this id. </P>",accessors=@PropertyAccessors(getAccess=PRIVATE),constraints=@PropertyConstraints(upperLimit=60)),@GeneratedProperty(name="series",type=Series.class,accessors=@PropertyAccessors(getAccess=PRIVATE),constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(persistent=false))}) public class IterationIdentifier extends wt.vc._IterationIdentifier
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:

  • Method Details

    • 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