com.rimerosolutions.ant.git.tasks.CurrentBranchTask Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ant-git-tasks Show documentation

Apache Ant Git tasks

There is a newer version: 1.3.2

/*
 * 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 java.io.IOException;

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

/**
 * Query the current branch.
 *
 * {@code
 * 
 *    
 * 
 * }
 *
 * Git branch documentation
 * JGit Repository API
 *
 * @author KenBarby
 */
public class CurrentBranchTask extends AbstractGitRepoAwareTask {

        private static final String TASK_NAME = "git-current-branch";

        private String outputProperty;

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

        /**
         * Sets the output property name
         *
         * @antdoc.required
         * @param outputProperty - required: the ant property name to assign the current branch value to
         */
        public void setOutputProperty(String outputProperty) {
                this.outputProperty = outputProperty;
        }

        @Override
        protected void doExecute() {
                try {
                        getProject().setProperty(outputProperty, git.getRepository().getBranch());
                } catch (IOException e) {
                        throw new GitBuildException("Could not query the current branch.", e);
                }
        }

}