Package org.eclipse.jgit.api

Class NameRevCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<java.util.Map<ObjectId,java.lang.String>>

org.eclipse.jgit.api.NameRevCommand

All Implemented Interfaces:

java.util.concurrent.Callable<java.util.Map<ObjectId,java.lang.String>>

public class NameRevCommand
extends GitCommand<java.util.Map<ObjectId,java.lang.String>>

Command to find human-readable names of revisions.

Since:

3.0

See Also:

Git documentation about name-rev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	NameRevCommand.NameRevCommit

Field Summary

Fields

Modifier and Type	Field	Description
private static int	COMMIT_TIME_SLOP	Amount of slop to allow walking past the earliest requested commit.
private static int	MERGE_COST	Cost of traversing a merge commit compared to a linear history.
private int	mergeCost
private java.util.List<java.lang.String>	prefixes
private java.util.List<Ref>	refs
private java.util.List<ObjectId>	revs
private RevWalk	walk

Fields inherited from class org.eclipse.jgit.api.GitCommand

repo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NameRevCommand(Repository repo)	Create a new name-rev command.

Method Summary

Modifier and Type	Method	Description
NameRevCommand	add(java.lang.Iterable<ObjectId> ids)	Add multiple objects to search for.
NameRevCommand	add(ObjectId id)	Add an object to search for.
NameRevCommand	addAnnotatedTags()	Add all annotated tags under refs/tags/ to the set that all results must match.
NameRevCommand	addPrefix(java.lang.String prefix)	Add a ref prefix to the set that results must match.
private void	addPrefix(java.lang.String prefix, java.util.Map<ObjectId,java.lang.String> nonCommits, FIFORevQueue pending)
private void	addPrefixes(java.util.Map<ObjectId,java.lang.String> nonCommits, FIFORevQueue pending)
NameRevCommand	addRef(Ref ref)	Add a ref to the set that all results must match.
private void	addRef(Ref ref, java.util.Map<ObjectId,java.lang.String> nonCommits, FIFORevQueue pending)
java.util.Map<ObjectId,java.lang.String>	call()
private long	compare(java.lang.String leftTip, long leftCost, java.lang.String rightTip, long rightCost)
private int	minCommitTime()
(package private) NameRevCommand	setMergeCost(int cost)
private static java.lang.String	simplify(java.lang.String refName)

Methods inherited from class org.eclipse.jgit.api.GitCommand

checkCallable, getRepository, setCallable

Methods inherited from class java.lang.Object

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

Field Detail

COMMIT_TIME_SLOP

private static final int COMMIT_TIME_SLOP

Amount of slop to allow walking past the earliest requested commit.

See Also:

Constant Field Values

MERGE_COST

private static final int MERGE_COST

Cost of traversing a merge commit compared to a linear history.

See Also:

Constant Field Values

walk

private final RevWalk walk

prefixes

private final java.util.List<java.lang.String> prefixes

revs

private final java.util.List<ObjectId> revs

refs

private java.util.List<Ref> refs

mergeCost

private int mergeCost

Constructor Detail

NameRevCommand

protected NameRevCommand(Repository repo)

Create a new name-rev command.

Parameters:

repo - the Repository

Method Detail

call

public java.util.Map<ObjectId,java.lang.String> call()
                                                    throws GitAPIException

Execute the command

Specified by:

call in interface java.util.concurrent.Callable<java.util.Map<ObjectId,java.lang.String>>

Specified by:

call in class GitCommand<java.util.Map<ObjectId,java.lang.String>>

Throws:

GitAPIException

add

public NameRevCommand add(ObjectId id)
                   throws MissingObjectException,
                          JGitInternalException

Add an object to search for.

Parameters:

id - object ID to add.

Returns:

this

Throws:

MissingObjectException - the object supplied is not available from the object database.

JGitInternalException - a low-level exception of JGit has occurred. The original exception can be retrieved by calling Throwable.getCause().

add

public NameRevCommand add(java.lang.Iterable<ObjectId> ids)
                   throws MissingObjectException,
                          JGitInternalException

Add multiple objects to search for.

Parameters:

ids - object IDs to add.

Returns:

this

Throws:

MissingObjectException - the object supplied is not available from the object database.

JGitInternalException - a low-level exception of JGit has occurred. The original exception can be retrieved by calling Throwable.getCause().

addPrefix

public NameRevCommand addPrefix(java.lang.String prefix)

Add a ref prefix to the set that results must match.

If an object matches multiple refs equally well, the first matching ref added with addRef(Ref) is preferred, or else the first matching prefix added by addPrefix(String).

Parameters:

prefix - prefix to add; the prefix must end with a slash

Returns:

this

addAnnotatedTags

public NameRevCommand addAnnotatedTags()

Add all annotated tags under refs/tags/ to the set that all results must match.

Calls addRef(Ref); see that method for a note on matching priority.

Returns:

this

Throws:

JGitInternalException - a low-level exception of JGit has occurred. The original exception can be retrieved by calling Throwable.getCause().

addRef

public NameRevCommand addRef(Ref ref)

Add a ref to the set that all results must match.

If an object matches multiple refs equally well, the first matching ref added with addRef(Ref) is preferred, or else the first matching prefix added by addPrefix(String).

Parameters:

ref - ref to add.

Returns:

this

setMergeCost

NameRevCommand setMergeCost(int cost)

addPrefixes

private void addPrefixes(java.util.Map<ObjectId,java.lang.String> nonCommits,
                         FIFORevQueue pending)
                  throws java.io.IOException

Throws:

java.io.IOException

addPrefix

private void addPrefix(java.lang.String prefix,
                       java.util.Map<ObjectId,java.lang.String> nonCommits,
                       FIFORevQueue pending)
                throws java.io.IOException

Throws:

java.io.IOException

addRef

private void addRef(Ref ref,
                    java.util.Map<ObjectId,java.lang.String> nonCommits,
                    FIFORevQueue pending)
             throws java.io.IOException

Throws:

java.io.IOException

minCommitTime

private int minCommitTime()
                   throws java.io.IOException

Throws:

java.io.IOException

compare

private long compare(java.lang.String leftTip,
                     long leftCost,
                     java.lang.String rightTip,
                     long rightCost)

simplify

private static java.lang.String simplify(java.lang.String refName)