Method Detail

• java.lang.Iterable<java.lang.String> allAncestorTags()

  Returns:

  All the tags in the repository that belong to ancestors of HEAD, including HEAD itself.

• java.lang.Iterable<java.lang.String> allTags()

  Returns:

  All the tags in the repository.

• GitRepo.Relation branchToBranchRelation(java.lang.String firstBranch, java.lang.String secondBranch)

  Returns:

  The Relation of the first branch to the second branch.

  Parameters:

  firstBranch

  secondBranch

• java.lang.Iterable<java.lang.String> centralBranches()

  Returns:

  All names of branches that remote-track branches on the central repository.

• java.lang.Iterable<java.lang.String> changes()

  Returns:

  All changes in the repository (staged and unstaged).

• void checkoutBranch(java.lang.String branchName)

  Checks out the branch with the given name. Does nothing if already checked out.

  Parameters:

  branchName

• void close()

  Call this to release underlying resources. No operation must be performed on the GitRepo instance after this method is called.

• java.lang.String commitIdOfBranch(java.lang.String branchName)

  Returns:

  The id of the commit that owns the given branch.

  Parameters:

  branchName

• java.lang.String commitIdOfTag(java.lang.String tagName)

  Returns:

  The id of the commit that owns the given tag.

  Parameters:

  tagName

• void commitSingleFile(java.lang.String file, java.lang.String commitMessage)

  Creates a commit consisting only of the given file, if possible. If the file is unstaged, it adds it to the staging area first. If the file is unchanged, or if there are other changes beside this file, throws an exception.

  Parameters:

  file - The path of the file to be committed, relative to the repository root

  commitMessage - A commit message

• void createLocalAndRemoteBranch(java.lang.String branchName, java.lang.String startPoint)

  Creates a local branch with the given name, starting from the given point, and a branch with the same name in the central repository, tracked by the local branch.

  Parameters:

  branchName

  startPoint - A branch name, a tag or a commit id

• void createLocalBranch(java.lang.String branchName, java.lang.String startPoint)

  Creates a non-tracking branch with the given name, starting from the given point.

  Parameters:

  branchName

  startPoint - A branch name, a tag or a commit id

• void createLocalBranchTrackingRemote(java.lang.String branchName, java.lang.String remoteBranchName)

  Creates a local branch with the given name, starting from the given remote branch and tracking it.

  Parameters:

  branchName

  remoteBranchName

• void createTag(java.lang.String tagName)

  Creates a tag with the given name.

  Parameters:

  tagName

• java.lang.String currentBranch()

  Returns:

  The name of the currently checked-out branch, or null if repository is in detached head.

• void fastForwardCurrentBranchTo(java.lang.String someOtherBranch)

  Merges the given branch into the currently checked-out branch in fast-forward-only mode. Throws exception if fast-forward is not possible.

  Parameters:

  someOtherBranch

• void fetchAllBranchesAndPrune()

  Fetches all the branches in the central repository, pruning all the remote-tracking branches that no longer exist on the central repository. No tags are fetched.

• void fetchAllTags()

  Fetches all the tags from the central repository. No branches are fetched.

• @java.lang.Deprecated void fetchBranches(java.lang.Iterable<java.lang.String> branchNames)

  Fetches only the branches with the given names from the central repository.

  Parameters:

  branchNames

• boolean isCentralBranch(java.lang.String branchName)

  Returns:

  true, if the given name belongs to a branch on the central repository, false, otherwise

  Parameters:

  branchName

• boolean isDetachedHead()

  Returns:

  true if the repository is in the detached head state, false otherwise

• boolean isLocalBranch(java.lang.String branchName)

  Returns:

  true, if the given name belongs to a local branch, false, otherwise

  Parameters:

  branchName

• boolean isLocalBranchTrackingRemoteBranch(java.lang.String branchName, java.lang.String remoteBranchName)

  Returns:

  true if the given branch is tracking the given remote branch false otherwise

  Parameters:

  branchName

  remoteBranchName

• boolean isTag(java.lang.String tagName)

  Returns:

  true if the repository has a tag with the given name, false otherwise

  Parameters:

  tagName

• java.lang.Iterable<java.lang.String> localBranches()

  Returns:

  All local branch names.

• void pushBranchToCentral(java.lang.String branchName)

  Pushed the given branch to the central repository.

  Parameters:

  branchName

• void pushBranchToCentralWithTags(java.lang.String branchName)

  Pushed the given branch to the central repository together with any existing tags.

  Parameters:

  branchName

• void pushTagsToCentral()

  Pushes all the tags to the central repository.

• void removeBranch(java.lang.String branchName)

  Removes the branch with the given name from the repository.

  Parameters:

  branchName

• void removeBranchOnCentral(java.lang.String branchName)

  Removes the branch with the given name from the central repository.

  Parameters:

  branchName - The name of a branch in the central repository.

• void resetCurrentBranchToCommit(java.lang.String commitId)

  Resets the currently checked-out branch to the commit with the given id in the local repository.

  Parameters:

  commitId

• java.lang.String rootDir()

  The absolute path of the repository.

• java.lang.Iterable<java.lang.String> stagedChanges()

  Returns:

  All staged changes in the repository.

• java.lang.Iterable<java.lang.String> unstagedChanges()

  Returns:

  All unstaged changes in the repository.