org.ajoberstar.grgit.operation.BranchListOp.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grgit Show documentation

The Groovy way to use Git.

There is a newer version: 1.8.0-rc.1

/*
 * Copyright 2012-2015 the original author or authors.
 *
 * 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 org.ajoberstar.grgit.operation

import java.util.concurrent.Callable

import org.ajoberstar.grgit.Branch
import org.ajoberstar.grgit.Repository
import org.ajoberstar.grgit.exception.GrgitException
import org.ajoberstar.grgit.util.JGitUtil

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

/**
 * Lists branches in the repository. Returns a list of {@link Branch}.
 *
 * To list local branches only.
 *
 *  * def branches = grgit.branch.list()
 * def branches = grgit.branch.list(mode: BranchListOp.Mode.LOCAL)
 * 
 *
 * To list remote branches only.
 *
 *  * def branches = grgit.branch.list(mode: BranchListOp.Mode.REMOTE)
 * 
 *
 * To list all branches.
 *
 *  * def branches = grgit.branch.list(mode: BranchListOp.Mode.ALL)
 * 
 *
 * See git-branch Manual Page.
 *
 * @since 0.2.0
 * @see git-branch Manual Page
 */
class BranchListOp implements Callable> {
	private final Repository repo

	/**
	 * Which branches to return.
	 */
	Mode mode = Mode.LOCAL

	BranchListOp(Repository repo) {
		this.repo = repo
	}

	List call() {
		ListBranchCommand cmd = repo.jgit.branchList()
		cmd.listMode = mode.jgit

		try {
			return cmd.call().collect {
				JGitUtil.resolveBranch(repo, it.name)
			}
		} catch (GitAPIException e) {
			throw new GrgitException('Problem listing branches.', e)
		}
	}

	static enum Mode {
		ALL(ListBranchCommand.ListMode.ALL),
		REMOTE(ListBranchCommand.ListMode.REMOTE),
		LOCAL(null)

		private final ListBranchCommand.ListMode jgit

		private Mode(ListBranchCommand.ListMode jgit) {
			this.jgit = jgit
		}
	}
}