public class DescribeCommand extends GitCommand<String>
repo| Modifier | Constructor and Description |
|---|---|
protected |
DescribeCommand(Repository repo) |
| Modifier and Type | Method and Description |
|---|---|
String |
call()
Describes the specified commit.
|
DescribeCommand |
setTarget(ObjectId target)
Sets the commit to be described.
|
DescribeCommand |
setTarget(String rev)
Sets the commit to be described.
|
checkCallable, getRepository, setCallableprotected DescribeCommand(Repository repo)
repo - public DescribeCommand setTarget(ObjectId target) throws IOException
target - A non-null object ID to be described.thisMissingObjectException - the supplied commit does not exist.IncorrectObjectTypeException - the supplied id is not a commit or an annotated tag.IOException - a pack file or loose object could not be read.public DescribeCommand setTarget(String rev) throws IOException, RefNotFoundException
rev - Commit ID, tag, branch, ref, etc.
See Repository.resolve(String) for allowed syntax.thisIncorrectObjectTypeException - the supplied id is not a commit or an annotated tag.RefNotFoundException - the given rev didn't resolve to any object.IOException - a pack file or loose object could not be read.public String call() throws GitAPIException
call in interface Callable<String>call in class GitCommand<String>If none of the ancestors of the commit being described has any tags at all, then this method returns null, indicating that there's no way to describe this tag.
GitAPIException - or subclass thereof when an error occursCopyright © 2014. All rights reserved.