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

Class BambooKey

java.lang.Object

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

com.atlassian.bamboo.specs.api.builders.BambooKey

public class BambooKey
extends EntityPropertiesBuilder<BambooKeyProperties>

Represents a short key of an Bamboo entity (project, plan, job, etc). This is partial key, for instance the value of plan key is "PLAN" rather than "PROJECT-PLAN". Keys serve as secondary identifiers of Bamboo entities, that is, whenever both key and BambooOid is present, BambooOid has higher priority.

See Also:

BambooOid

Constructor Summary

Constructors

Constructor	Description
BambooKey(@NotNull String key)	Specify key of provided value.

Method Summary

Modifier and Type	Method	Description
protected BambooKeyProperties	build()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BambooKey

public BambooKey(@NotNull
                 @NotNull String key)
          throws PropertiesValidationException

Specify key of provided value.

Throws:

PropertiesValidationException

Method Detail

build

protected BambooKeyProperties build()
                             throws PropertiesValidationException

Specified by:

build in class EntityPropertiesBuilder<BambooKeyProperties>

Throws:

PropertiesValidationException

toString

public String toString()

Overrides:

toString in class Object