org.uberfire.java.nio.fs.jgit.util.commands

Class GitCommand

java.lang.Object

org.uberfire.java.nio.fs.jgit.util.commands.GitCommand

Direct Known Subclasses:

Clone, DiffBranches, Merge, Squash

public abstract class GitCommand
extends Object

GitCommand is an abstract class were every git command should extend. You have to implement the "execute" method. It returns an Optional to represent a response. That response could be "a value" or "empty". So, if you code returns nothing, just do "return Optional.empty".

Constructor Summary

Constructors

Constructor and Description
GitCommand()

Method Summary

Modifier and Type	Method and Description
abstract <T> Optional<T>	execute() This method has to be implemented by subclasses to execute the git command.
protected org.eclipse.jgit.revwalk.RevCommit	getRevCommit(org.eclipse.jgit.lib.ObjectId startCommitObjectId, org.eclipse.jgit.revwalk.RevWalk revWalk) Based on the start commit and the revWalk I return the a reference to a commit (RevCommit)
protected org.eclipse.jgit.revwalk.RevTree	getRevTree(org.eclipse.jgit.revwalk.RevWalk revWalk, org.eclipse.jgit.revwalk.RevCommit commit)
protected org.eclipse.jgit.lib.ObjectId	getStartCommit(org.eclipse.jgit.api.Git git, String startCommitString) Resolves the objectId of the start commit.
protected void	isBare(org.eclipse.jgit.lib.Repository repository) Check if the repository is bare, if not throws an IllegalStateException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitCommand

public GitCommand()

Method Detail

execute

public abstract <T> Optional<T> execute()

This method has to be implemented by subclasses to execute the git command. Remember that if you want to apply parameters you have to do it in your own constructor.

Type Parameters:

T - The type of the returning optional.

Returns:

a value that may be the returning object or empty.

getRevTree

protected org.eclipse.jgit.revwalk.RevTree getRevTree(org.eclipse.jgit.revwalk.RevWalk revWalk,
                                                      org.eclipse.jgit.revwalk.RevCommit commit)

getRevCommit

protected org.eclipse.jgit.revwalk.RevCommit getRevCommit(org.eclipse.jgit.lib.ObjectId startCommitObjectId,
                                                          org.eclipse.jgit.revwalk.RevWalk revWalk)

Based on the start commit and the revWalk I return the a reference to a commit (RevCommit)

Parameters:

startCommitObjectId - the objectId to search the revision commit.

revWalk - the object that walks into the commit graph.

Returns:

the revision commit parsed from the commit graph.

isBare

protected void isBare(org.eclipse.jgit.lib.Repository repository)

Check if the repository is bare, if not throws an IllegalStateException

Parameters:

repository - Git Repository you need to check

getStartCommit

protected org.eclipse.jgit.lib.ObjectId getStartCommit(org.eclipse.jgit.api.Git git,
                                                       String startCommitString)

Resolves the objectId of the start commit.

Parameters:

git - the repository that contain the commit.

startCommitString - a String with the id of the commit.

Returns:

the commit objectid.