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

Class VcsRepositoryIdentifier

java.lang.Object

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

com.atlassian.bamboo.specs.api.builders.repository.VcsRepositoryIdentifier

public class VcsRepositoryIdentifier
extends EntityPropertiesBuilder<VcsRepositoryIdentifierProperties>

References a vcs repository.

The exact semantics of this class depends on the context in which it is used. In particular, possible values can be restricted only to repositories that are linked to particular plan. In other contexts a reference to any global repository is allowed.

Constructor Summary

Constructors

Constructor	Description
VcsRepositoryIdentifier()
VcsRepositoryIdentifier(@NotNull BambooOid oid)	References repository by oid.
VcsRepositoryIdentifier(@NotNull java.lang.String name)	References repository by name.

Method Summary

Modifier and Type	Method	Description
protected VcsRepositoryIdentifierProperties	build()
VcsRepositoryIdentifier	name(@NotNull java.lang.String name)	References repository by name.
VcsRepositoryIdentifier	oid(@NotNull BambooOid oid)	References repository by oid.
VcsRepositoryIdentifier	oid(@NotNull java.lang.String oid)	References repository by oid.

Methods inherited from class java.lang.Object

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

Constructor Detail

VcsRepositoryIdentifier

public VcsRepositoryIdentifier()
                        throws PropertiesValidationException

Throws:

PropertiesValidationException

VcsRepositoryIdentifier

public VcsRepositoryIdentifier(@NotNull
                               @NotNull java.lang.String name)
                        throws PropertiesValidationException

References repository by name. Name of the repository is ignored if oid is defined.

Throws:

PropertiesValidationException

VcsRepositoryIdentifier

public VcsRepositoryIdentifier(@NotNull
                               @NotNull BambooOid oid)
                        throws PropertiesValidationException

References repository by oid.

In many contexts, e.g. when linking repository to a plan, it will be matched to both repository's oid and parent oid.

Throws:

PropertiesValidationException

Method Detail

name

public VcsRepositoryIdentifier name(@NotNull
                                    @NotNull java.lang.String name)
                             throws PropertiesValidationException

References repository by name. Name of the repository is ignored if oid is defined.

Throws:

PropertiesValidationException

oid

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

References repository by oid.

In many contexts, e.g. when linking repository to a plan, it will be matched to both repository's oid and parent oid.

Throws:

PropertiesValidationException

oid

public VcsRepositoryIdentifier oid(@NotNull
                                   @NotNull BambooOid oid)
                            throws PropertiesValidationException

References repository by oid.

In many contexts, e.g. when linking repository to a plan, it will be matched to both repository's oid and parent oid.

Throws:

PropertiesValidationException

build

protected VcsRepositoryIdentifierProperties build()
                                           throws PropertiesValidationException

Specified by:

build in class EntityPropertiesBuilder<VcsRepositoryIdentifierProperties>

Throws:

PropertiesValidationException