Package org.eclipse.jgit.api

Class TagCommand

  • All Implemented Interfaces:
    java.util.concurrent.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 Detail

      • name

        private java.lang.String name

      • message

        private java.lang.String message

      • signed

        private boolean signed

      • forceUpdate

        private boolean forceUpdate

      • annotated

        private boolean annotated

    • Constructor Detail

      • TagCommand

        protected TagCommand​(Repository repo)

        Constructor for TagCommand.

        Parameters:
        repo - a Repository object.

    • Method Detail

      • processOptions

        private void processOptions​(RepositoryState state)
                     throws InvalidTagNameException
        Sets default values for not explicitly specified options. Then validates that all required data has been provided.
        Parameters:
        state - the state of the repository we are working on
        Throws:
        InvalidTagNameException - if the tag name is null or invalid
        java.lang.UnsupportedOperationException - if the tag is signed (not supported yet)

      • setName

        public TagCommand setName​(java.lang.String name)
        Set the tag name.
        Parameters:
        name - the tag name used for the tag
        Returns:
        this

      • getName

        public java.lang.String getName()
        Get the tag name.
        Returns:
        the tag name used for the tag

      • getMessage

        public java.lang.String getMessage()
        Get the tag message.
        Returns:
        the tag message used for the tag

      • setMessage

        public TagCommand setMessage​(java.lang.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