Class RevTag

All Implemented Interfaces:
Serializable, Comparable<AnyObjectId>

public class RevTag extends RevObject
An annotated tag.
See Also:
  • Field Details

    • hSignature

      private static final byte[] hSignature
    • object

      private RevObject object
    • buffer

      private byte[] buffer
    • tagName

      private String tagName
  • Constructor Details

    • RevTag

      protected RevTag(AnyObjectId id)
      Create a new tag reference.
      Parameters:
      id - object name for the tag.
  • Method Details

    • parse

      public static RevTag parse(byte[] raw) throws CorruptObjectException
      Parse an annotated tag from its canonical format. This method constructs a temporary revision pool, parses the tag as supplied, and returns it to the caller. Since the tag was built inside of a private revision pool its object pointer will be initialized, but will not have its headers loaded. Applications are discouraged from using this API. Callers usually need more than one object. Use RevWalk.parseTag(AnyObjectId) to obtain a RevTag from an existing repository.
      Parameters:
      raw - the canonical formatted tag to be parsed.
      Returns:
      the parsed tag, in an isolated revision pool that is not available to the caller.
      Throws:
      CorruptObjectException - the tag contains a malformed header that cannot be handled.
    • parse

      public static RevTag parse(RevWalk rw, byte[] raw) throws CorruptObjectException
      Parse an annotated tag from its canonical format.

      This method inserts the tag directly into the caller supplied revision pool, making it appear as though the tag exists in the repository, even if it doesn't. The repository under the pool is not affected.

      The body of the tag (message, tagger, signature) is always retained in the returned RevTag, even if the supplied RevWalk has been configured with setRetainBody(false).

      Parameters:
      rw - the revision pool to allocate the tag within. The tag's object pointer will be obtained from this pool.
      raw - the canonical formatted tag to be parsed. This buffer will be retained by the returned RevTag and must not be modified by the caller.
      Returns:
      the parsed tag, in an isolated revision pool that is not available to the caller.
      Throws:
      CorruptObjectException - the tag contains a malformed header that cannot be handled.
    • parseHeaders

      Specified by:
      parseHeaders in class RevObject
      Throws:
      MissingObjectException
      IncorrectObjectTypeException
      IOException
    • parseBody

      Specified by:
      parseBody in class RevObject
      Throws:
      MissingObjectException
      IncorrectObjectTypeException
      IOException
    • parseCanonical

      void parseCanonical(RevWalk walk, byte[] rawTag) throws CorruptObjectException
      Throws:
      CorruptObjectException
    • getType

      public final int getType()
      Get Git object type. See Constants.
      Specified by:
      getType in class RevObject
      Returns:
      object type
    • getTaggerIdent

      public final PersonIdent getTaggerIdent()
      Parse the tagger identity from the raw buffer.

      This method parses and returns the content of the tagger line, after taking the tag's character set into account and decoding the tagger name and email address. This method is fairly expensive and produces a new PersonIdent instance on each invocation. Callers should invoke this method only if they are certain they will be outputting the result, and should cache the return value for as long as necessary to use all information from it.

      Returns:
      identity of the tagger (name, email) and the time the tag was made by the tagger; null if no tagger line was found.
    • nextStart

      private static int nextStart(byte[] prefix, byte[] buffer, int from)
    • getSignatureStart

      private int getSignatureStart()
    • getRawGpgSignature

      @Nullable public final byte[] getRawGpgSignature()
      Parse the GPG signature from the raw buffer.
      Returns:
      contents of the GPG signature; null if the tag was not signed.
      Since:
      5.11
    • getFullMessage

      public final String getFullMessage()
      Parse the complete tag message and decode it to a string.

      This method parses and returns the message portion of the tag buffer, after taking the tag's character set into account and decoding the buffer using that character set. This method is a fairly expensive operation and produces a new string on each invocation.

      Returns:
      decoded tag message as a string. Never null.
    • getShortMessage

      public final String getShortMessage()
      Parse the tag message and return the first "line" of it.

      The first line is everything up to the first pair of LFs. This is the "oneline" format, suitable for output in a single line display.

      This method parses and returns the message portion of the tag buffer, after taking the tag's character set into account and decoding the buffer using that character set. This method is a fairly expensive operation and produces a new string on each invocation.

      Returns:
      decoded tag message as a string. Never null. The returned string does not contain any LFs, even if the first paragraph spanned multiple lines. Embedded LFs are converted to spaces.
    • guessEncoding

      private Charset guessEncoding()
    • getObject

      public final RevObject getObject()
      Get a reference to the object this tag was placed on.

      Note that the returned object has only been looked up (see RevWalk.lookupAny(AnyObjectId, int). To access the contents it needs to be parsed, see RevWalk.parseHeaders(RevObject) and RevWalk.parseBody(RevObject).

      As an alternative, use RevWalk.peel(RevObject) and pass this RevTag to peel it until the first non-tag object.

      Returns:
      object this tag refers to (only looked up, not parsed)
    • getTagName

      public final String getTagName()
      Get the name of this tag, from the tag header.
      Returns:
      name of the tag, according to the tag header.
    • getRawBuffer

      public final byte[] getRawBuffer()
      Obtain the raw unparsed tag body (NOTE - THIS IS NOT A COPY).

      This method is exposed only to provide very fast, efficient access to this tag's message buffer. Applications relying on this buffer should be very careful to ensure they do not modify its contents during their use of it.

      Returns:
      the raw unparsed tag body. This is NOT A COPY. Do not alter the returned array.
      Since:
      5.11
    • disposeBody

      public final void disposeBody()
      Discard the message buffer to reduce memory usage.

      After discarding the memory usage of the RevTag is reduced to only the getObject() pointer and getTagName(). Accessing other properties such as getTaggerIdent() or either message function requires reloading the buffer by invoking RevWalk.parseBody(RevObject).

      Since:
      4.0