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 and Description
protected	TagCommand(Repository repo) Constructor for TagCommand.

Method Summary

Modifier and Type	Method and Description
Ref	call()
String	getMessage() Get the tag message.
String	getName() Get the tag name.
RevObject	getObjectId() Get the tag's object id
PersonIdent	getTagger() Get the tagger who created the tag.
boolean	isAnnotated() Whether this will create an annotated command
boolean	isForceUpdate() Whether this is a forced update
boolean	isSigned() Whether this tag is signed
TagCommand	setAnnotated(boolean annotated) Configure this tag to be created as an annotated tag
TagCommand	setForceUpdate(boolean forceUpdate) If set to true the Tag command may replace an existing tag object.
TagCommand	setMessage(String message) Set the tag message.
TagCommand	setName(String name) Set the tag 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)

Constructor for TagCommand.

Parameters:

repo - a Repository object.

Method Detail

call

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

Execute the command

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>

Throws:

GitAPIException

ConcurrentRefUpdateException

InvalidTagNameException

NoHeadException

Since:

2.0

setName

public TagCommand setName(String name)

Set the tag name.

Parameters:

name - the tag name used for the tag

Returns:

this

getName

public String getName()

Get the tag name.

Returns:

the tag name used for the tag

getMessage

public String getMessage()

Get the tag message.

Returns:

the tag message used for the tag

setMessage

public TagCommand setMessage(String message)

Set the tag message.

Parameters:

message - the tag message used for the tag

Returns:

this

isSigned

public boolean isSigned()

Whether this tag is signed

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 - a boolean.

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 - a PersonIdent object.

Returns:

this

getTagger

public PersonIdent getTagger()

Get the tagger who created the tag.

Returns:

the tagger of the tag

getObjectId

public RevObject getObjectId()

Get the tag's object id

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 - a RevObject object.

Returns:

this

isForceUpdate

public boolean isForceUpdate()

Whether this is a forced update

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 - whether this is a forced update

Returns:

this

setAnnotated

public TagCommand setAnnotated(boolean annotated)

Configure this tag to be created as an annotated tag

Parameters:

annotated - whether this shall be an annotated tag

Returns:

this

Since:

3.0

isAnnotated

public boolean isAnnotated()

Whether this will create an annotated command

Returns:

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

Since:

3.0