com.atlassian.bamboo.specs.builders.task

Class VcsCheckoutTask

java.lang.Object

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

com.atlassian.bamboo.specs.api.builders.task.Task<VcsCheckoutTask,VcsCheckoutTaskProperties>

com.atlassian.bamboo.specs.builders.task.VcsCheckoutTask

public class VcsCheckoutTask
extends Task<VcsCheckoutTask,VcsCheckoutTaskProperties>

Represents task that checks out selected repositories to the build working directory.

Field Summary

Fields inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

description, requirements, taskEnabled

Constructor Summary

Constructors

Constructor and Description
VcsCheckoutTask()

Method Summary

Modifier and Type	Method and Description
VcsCheckoutTask	addCheckoutOfDefaultRepository() Adds checkout request for the plan's default repository into the build directory.
VcsCheckoutTask	addCheckoutOfRepository(String repositoryName) Adds checkout request for one of plan's repositories into the build directory.
VcsCheckoutTask	addCheckoutOfRepository(VcsRepositoryIdentifier repositoryIdentifier) Adds checkout request for one of plan's repositories into the build directory.
protected VcsCheckoutTaskProperties	build()
VcsCheckoutTask	checkoutItems(CheckoutItem... checkoutItems) Adds checkout requests.
VcsCheckoutTask	cleanCheckout(boolean cleanCheckout) Enables/disabled clean checkout.

Methods inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

description, enabled, requirements

Methods inherited from class java.lang.Object

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

Constructor Detail

VcsCheckoutTask

public VcsCheckoutTask()

Method Detail

addCheckoutOfDefaultRepository

public VcsCheckoutTask addCheckoutOfDefaultRepository()

Adds checkout request for the plan's default repository into the build directory. Default repository is the repository which is the first on the list of plan's repositories.

The repository will be checked out to the build's working directory. For more control over checkout path, use checkoutItems(CheckoutItem...).

addCheckoutOfRepository

public VcsCheckoutTask addCheckoutOfRepository(@NotNull
                                               String repositoryName)

Adds checkout request for one of plan's repositories into the build directory.

The repository will be checked out to the build's working directory. For more control over checkout path, use checkoutItems(CheckoutItem...).

addCheckoutOfRepository

public VcsCheckoutTask addCheckoutOfRepository(@NotNull
                                               VcsRepositoryIdentifier repositoryIdentifier)

Adds checkout request for one of plan's repositories into the build directory.

The repository will be checked out to the build's working directory. For more control over checkout path, use checkoutItems(CheckoutItem...).

checkoutItems

public VcsCheckoutTask checkoutItems(@NotNull
                                     CheckoutItem... checkoutItems)

Adds checkout requests.

cleanCheckout

public VcsCheckoutTask cleanCheckout(boolean cleanCheckout)

Enables/disabled clean checkout. If set, the task cleans the content of the checkout target directory before checking out the source. Off by default.

build

@NotNull
protected VcsCheckoutTaskProperties build()

Overrides:

build in class Task<VcsCheckoutTask,VcsCheckoutTaskProperties>