Given a commit, show the most recent tag that is reachable from a commit.
- Since:
- 3.2
-
Field Summary
Fields inherited from class org.eclipse.jgit.api.GitCommand
repo
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DescribeCommand
(Repository repo) Constructor for DescribeCommand. -
Method Summary
Modifier and TypeMethodDescriptioncall()
setAbbrev
(int abbrev) Sets the prefix length to use when abbreviating an object SHA-1.setAll
(boolean all) Instead of using only the annotated tags, use any ref found in refs/ namespace.setAlways
(boolean always) Always describe the commit by eventually falling back to a uniquely abbreviated commit hash if no other name matches.setLong
(boolean longDesc) Determine whether always to use the long format or not.Sets one or moreglob(7)
patterns that tags must match to be considered.setTags
(boolean tags) Instead of using only the annotated tags, use any tag found in refs/tags namespace.Sets the commit to be described.Sets the commit to be described.Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
Constructor Details
-
DescribeCommand
Constructor for DescribeCommand.- Parameters:
repo
- theRepository
-
-
Method Details
-
setTarget
Sets the commit to be described.- Parameters:
target
- A non-null object ID to be described.- Returns:
this
- Throws:
MissingObjectException
- 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.
-
setTarget
Sets the commit to be described.- Parameters:
rev
- Commit ID, tag, branch, ref, etc. SeeRepository.resolve(String)
for allowed syntax.- Returns:
this
- Throws:
IncorrectObjectTypeException
- 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.
-
setLong
Determine whether always to use the long format or not. When set totrue
the long format is used even the commit matches a tag.- Parameters:
longDesc
-true
if always the long format should be used.- Returns:
this
- Since:
- 4.0
- See Also:
-
setAll
Instead of using only the annotated tags, use any ref found in refs/ namespace. This option enables matching any known branch, remote-tracking branch, or lightweight tag.- Parameters:
all
-true
enables matching any ref found in refs/ like setting option --all in c git- Returns:
this
- Since:
- 5.10
-
setTags
Instead of using only the annotated tags, use any tag found in refs/tags namespace. This option enables matching lightweight (non-annotated) tags or not.- Parameters:
tags
-true
enables matching lightweight (non-annotated) tags like setting option --tags in c git- Returns:
this
- Since:
- 5.0
-
setAlways
Always describe the commit by eventually falling back to a uniquely abbreviated commit hash if no other name matches.- Parameters:
always
-true
enables falling back to a uniquely abbreviated commit hash- Returns:
this
- Since:
- 5.4
-
setAbbrev
Sets the prefix length to use when abbreviating an object SHA-1. -
setMatch
Sets one or moreglob(7)
patterns that tags must match to be considered. If multiple patterns are provided, tags only need match one of them.- Parameters:
patterns
- theglob(7)
pattern or patterns- Returns:
this
- Throws:
InvalidPatternException
- if the pattern passed in was invalid.- Since:
- 4.9
- See Also:
-
call
Execute the command
Describes the specified commit. Target defaults to HEAD if no commit was set explicitly.
- Specified by:
call
in interfaceCallable<String>
- Specified by:
call
in classGitCommand<String>
- Throws:
GitAPIException
-