com.itemis.maven.plugins.unleash.scm.requests.DeleteBranchRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unleash-scm-provider-api Show documentation

The API used by the Unleash Maven Plugin to talk to different SCM providers.

There is a newer version: 3.1.0

Show newest version

package com.itemis.maven.plugins.unleash.scm.requests;

import com.google.common.base.Preconditions;
import com.google.common.base.Strings;

/**
 * A Request for deleting a branch of the repository.

 * USE {@link #builder()} TO CREATE A REQUEST!

 *
 * @author Stanley Hillner
 * @since 0.1.0
 */
public class DeleteBranchRequest {
  private String message;
  private boolean push;
  private String branchName;

  private DeleteBranchRequest() {
    // use builder!
  }

  public static Builder builder() {
    return new Builder();
  }

  public String getMessage() {
    return this.message;
  }

  public boolean push() {
    return this.push;
  }

  public String getBranchName() {
    return this.branchName;
  }

  /**
   * The builder for a {@link DeleteBranchRequest}.
   *
   * @author Stanley Hillner
   * @since 0.1.0
   */
  public static class Builder {
    private DeleteBranchRequest request = new DeleteBranchRequest();

    /**
     * @param message the repository log message (mandatory).
     * @return the builder itself.
     */
    public Builder message(String message) {
      this.request.message = message;
      return this;
    }

    /**
     * Request pushing to the remote repository in case of distributed SCMs.
     *
     * @return the builder itself.
     */
    public Builder push() {
      this.request.push = true;
      return this;
    }

    /**
     * @param branchName the name of the branch that shall be deleted (mandatory).
     * @return the builder itself.
     */
    public Builder branchName(String branchName) {
      this.request.branchName = branchName;
      return this;
    }

    /**
     * Checks the settings of the request to build and builds the actual branch deletion request.
     *
     * @return the request for deleting a repository branch.
     */
    public DeleteBranchRequest build() {
      Preconditions.checkState(!Strings.isNullOrEmpty(this.request.branchName), "No branch name specified!");
      Preconditions.checkState(this.request.message != null, "No log message specified!");
      return this.request;
    }
  }
}