BranchDeleteTask.java

/*
 * Copyright 2013 Rimero Solutions
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.rimerosolutions.ant.git.tasks;

import org.eclipse.jgit.api.errors.GitAPIException;

import com.rimerosolutions.ant.git.AbstractGitRepoAwareTask;
import com.rimerosolutions.ant.git.GitBuildException;
import com.rimerosolutions.ant.git.GitTaskUtils;

/**
 * Delete branches.
 *
 * <pre>{@code
 * <git:git directory="${testLocalRepo}" verbose="true">
 *    <git:checkout branchName="${master.branch.name}"/>
 *    <git:branchDelete failonerror="true" branches="${dummy.checkout.branch}"/>
 * </git:git>}</pre>
 *
 * <p><a href="http://www.kernel.org/pub/software/scm/git/docs/git-branch.html">Git branch documentation</a></p>
 * <p><a href="http://download.eclipse.org/jgit/docs/latest/apidocs/org/eclipse/jgit/api/DeleteBranchCommand.html">JGit DeleteBranchCommand</a></p>
 *
 * @author Yves Zoundi
 */
public class BranchDeleteTask extends AbstractGitRepoAwareTask {

        private static final String TASK_NAME = "git-branch-delete";
        private String[] branchNames;

        @Override
        public String getName() {
                return TASK_NAME;
        }

        /**
         * Sets the branches to delete (comma-separated list)
         *
         * @param branches comma-separated list of branches to delete
         */
        public void setBranches(String branches) {
                if (!GitTaskUtils.isNullOrBlankString(branches)) {
                        this.branchNames = branches.split(",");
                }
                else {
                        throw new GitBuildException("Cannot delete unspecified branches.");
                }
        }

        @Override
        protected void doExecute() {
                try {
                        git.branchDelete().setBranchNames(branchNames).call();
                } catch (GitAPIException e) {
                        throw new GitBuildException("Could not delete specified branches.", e);
                }
        }

}