Class 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
    • Constructor Detail

      • TagCommand

        protected TagCommand​(Repository repo)
        Parameters:
        repo -
    • Method Detail

      • 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