com.atlassian.bamboo.specs.api.builders.project

Class Project

java.lang.Object

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

com.atlassian.bamboo.specs.api.builders.RootEntityPropertiesBuilder<ProjectProperties>

com.atlassian.bamboo.specs.api.builders.project.Project

public class Project
extends RootEntityPropertiesBuilder<ProjectProperties>

Represents Bamboo project.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
Project() Specifies Bamboo project.

Method Summary

Modifier and Type	Method and Description
protected ProjectProperties	build()
Project	description(@Nullable String description) Sets a project description.
BambooKey	getKey() Returns project's key.
String	getName() Returns project's name.
BambooOid	getOid() Returns project's oid.
String	humanReadableId() Entity type and id representation that is shown to human.
String	humanReadableType() Entity type that is shown to human.
Project	key(@Nullable BambooKey key) Sets a project key.
Project	key(@Nullable String key) Sets a project key.
Project	name(@NotNull String name) Sets a project name.
Project	oid(@Nullable BambooOid oid) Sets a project's oid.
Project	oid(@Nullable String oid) Sets a project's oid.
Project	repositories(VcsRepository<?,?>... repositories) Adds project repositories.
Project	sharedCredentials(SharedCredentials<?,?>... credentials) Adds project shared credentials.
Project	variables(Variable... variables) Adds project variables.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

Project

public Project()
        throws PropertiesValidationException

Specifies Bamboo project.

Throws:

PropertiesValidationException

Method Detail

name

public Project name(@NotNull
                    @NotNull String name)
             throws PropertiesValidationException

Sets a project name.

Throws:

PropertiesValidationException

key

public Project key(@Nullable
                   @Nullable String key)
            throws PropertiesValidationException

Sets a project key. In the absence of oid key serves as project identifier.

Throws:

PropertiesValidationException

key

public Project key(@Nullable
                   @Nullable BambooKey key)
            throws PropertiesValidationException

Sets a project key. In the absence of oid key serves as project identifier.

Throws:

PropertiesValidationException

description

public Project description(@Nullable
                           @Nullable String description)
                    throws PropertiesValidationException

Sets a project description.

Throws:

PropertiesValidationException

oid

public Project oid(@Nullable
                   @Nullable String oid)
            throws PropertiesValidationException

Sets a project's oid.

Throws:

PropertiesValidationException

oid

public Project oid(@Nullable
                   @Nullable BambooOid oid)
            throws PropertiesValidationException

Sets a project's oid.

Throws:

PropertiesValidationException

variables

public Project variables(@NotNull
                         Variable... variables)

Adds project variables.

sharedCredentials

public Project sharedCredentials(@NotNull
                                 SharedCredentials<?,?>... credentials)

Adds project shared credentials.

repositories

public Project repositories(@NotNull
                            VcsRepository<?,?>... repositories)

Adds project repositories. This method will create new project level repository definitions.

getOid

public BambooOid getOid()

Returns project's oid.

Throws:

IllegalStateException - if oid is undefined

getKey

public BambooKey getKey()

Returns project's key.

Throws:

IllegalStateException - if key is undefined

getName

public String getName()

Returns project's name.

build

protected ProjectProperties build()
                           throws PropertiesValidationException

Specified by:

build in class EntityPropertiesBuilder<ProjectProperties>

Throws:

PropertiesValidationException

humanReadableType

public String humanReadableType()

Description copied from class: RootEntityPropertiesBuilder

Entity type that is shown to human.

Specified by:

humanReadableType in class RootEntityPropertiesBuilder<ProjectProperties>

humanReadableId

public String humanReadableId()

Description copied from class: RootEntityPropertiesBuilder

Entity type and id representation that is shown to human.

Specified by:

humanReadableId in class RootEntityPropertiesBuilder<ProjectProperties>