Package 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 com.atlassian.bamboo.specs.api.builders.task.Task<VcsCheckoutTask,VcsCheckoutTaskProperties>
Represents task that checks out selected repositories to the build working directory.

  • Constructor Details

    • VcsCheckoutTask

      public VcsCheckoutTask()

  • Method Details

    • 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 @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 @NotNull com.atlassian.bamboo.specs.api.builders.repository.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 @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 @NotNull VcsCheckoutTaskProperties build()
      Specified by:
      build in class com.atlassian.bamboo.specs.api.builders.task.Task<VcsCheckoutTask,VcsCheckoutTaskProperties>

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class com.atlassian.bamboo.specs.api.builders.task.Task<VcsCheckoutTask,VcsCheckoutTaskProperties>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class com.atlassian.bamboo.specs.api.builders.task.Task<VcsCheckoutTask,VcsCheckoutTaskProperties>

    • toString

      public String toString()
      Overrides:
      toString in class com.atlassian.bamboo.specs.api.builders.task.Task<VcsCheckoutTask,VcsCheckoutTaskProperties>