Package org.eclipse.jgit.api

Class TagCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<Ref>

org.eclipse.jgit.api.TagCommand

All Implemented Interfaces:

Callable<Ref>

public class TagCommand
extends GitCommand<Ref>

Create/update an annotated tag object or a simple unannotated tag

Examples (git is a Git instance):

Create a new tag for the current commit:

 git.tag().setName("v1.0").setMessage("First stable release").call();
 

Create a new unannotated tag for the current commit:

 git.tag().setName("v1.0").setAnnotated(false).call();
 

See Also:

Git documentation about Tag

Field Summary

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

repo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TagCommand(Repository repo)

Method Summary

Modifier and Type	Method	Description
Ref	call()	Executes the tag command with all the options and parameters collected by the setter methods of this class.
String	getMessage()
String	getName()
RevObject	getObjectId()
PersonIdent	getTagger()
boolean	isAnnotated()
boolean	isForceUpdate()
boolean	isSigned()
TagCommand	setAnnotated(boolean annotated)
TagCommand	setForceUpdate(boolean forceUpdate)	If set to true the Tag command may replace an existing tag object.
TagCommand	setMessage(String message)
TagCommand	setName(String name)
TagCommand	setObjectId(RevObject id)	Sets the object id of the tag.
TagCommand	setSigned(boolean signed)	If set to true the Tag command creates a signed tag object.
TagCommand	setTagger(PersonIdent tagger)	Sets the tagger of the tag.

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

Constructor Detail

TagCommand

protected TagCommand(Repository repo)

Parameters:

repo -

Method Detail

call

public Ref call()
         throws GitAPIException,
                ConcurrentRefUpdateException,
                InvalidTagNameException,
                NoHeadException

Executes the tag command with all the options and parameters collected by the setter methods of this class. Each instance of this class should only be used for one invocation of the command (means: one call to call())

Specified by:

call in interface Callable<Ref>

Specified by:

call in class GitCommand<Ref>

Returns:

a Ref a ref pointing to a tag

Throws:

NoHeadException - when called on a git repo without a HEAD reference

GitAPIException - or subclass thereof when an error occurs

ConcurrentRefUpdateException

InvalidTagNameException

Since:

2.0

setName

public TagCommand setName(String name)

Parameters:

name - the tag name used for the tag

Returns:

this

getName

public String getName()

Returns:

the tag name used for the tag

getMessage

public String getMessage()

Returns:

the tag message used for the tag

setMessage

public TagCommand setMessage(String message)

Parameters:

message - the tag message used for the tag

Returns:

this

isSigned

public boolean isSigned()

Returns:

whether the tag is signed

setSigned

public TagCommand setSigned(boolean signed)

If set to true the Tag command creates a signed tag object. This corresponds to the parameter -s on the command line.

Parameters:

signed -

Returns:

this

setTagger

public TagCommand setTagger(PersonIdent tagger)

Sets the tagger of the tag. If the tagger is null, a PersonIdent will be created from the info in the repository.

Parameters:

tagger -

Returns:

this

getTagger

public PersonIdent getTagger()

Returns:

the tagger of the tag

getObjectId

public RevObject getObjectId()

Returns:

the object id of the tag

setObjectId

public TagCommand setObjectId(RevObject id)

Sets the object id of the tag. If the object id is null, the commit pointed to from HEAD will be used.

Parameters:

id -

Returns:

this

isForceUpdate

public boolean isForceUpdate()

Returns:

is this a force update

setForceUpdate

public TagCommand setForceUpdate(boolean forceUpdate)

If set to true the Tag command may replace an existing tag object. This corresponds to the parameter -f on the command line.

Parameters:

forceUpdate -

Returns:

this

setAnnotated

public TagCommand setAnnotated(boolean annotated)

Parameters:

annotated -

Returns:

this

Since:

3.0

isAnnotated

public boolean isAnnotated()

Returns:

true if this command will create an annotated tag (default is true)

Since:

3.0