Package com.atlassian.bamboo.specs.api.builders

Class BambooOid

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<BambooOidProperties>

com.atlassian.bamboo.specs.api.builders.BambooOid

public class BambooOid
extends EntityPropertiesBuilder<BambooOidProperties>

Represents an unique identifier of Bamboo entity (project, plan, repository, job, etc.) Those identifiers are generated by Bamboo and thus are not available when creating new objects, therefore secondary identifiers, i.e. BambooKey and names can be used as well. It is recommended however, to use these identifiers when updating existing Bamboo data or transfering data between Bamboo servers as they provide stronger guarantees nb. uniqueness.

If both oid and a secondary identifier is present, oid has higher priority. In particular, when both oid and name is present it is possible to rename an existing object.

See Also:

BambooKey

Constructor Summary

Constructors

Constructor	Description
BambooOid(@NotNull java.lang.String oid)	Specify an entity oid from its string value.

Method Summary

Modifier and Type	Method	Description
protected BambooOidProperties	build()

Methods inherited from class java.lang.Object

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

Constructor Detail

BambooOid

public BambooOid(@NotNull
                 @NotNull java.lang.String oid)
          throws PropertiesValidationException

Specify an entity oid from its string value.

Parameters:

oid - oid in string format (long number in Character.MAX_RADIX radix)

Throws:

PropertiesValidationException

Method Detail

build

protected BambooOidProperties build()
                             throws PropertiesValidationException

Specified by:

build in class EntityPropertiesBuilder<BambooOidProperties>

Throws:

PropertiesValidationException