Class LfsPointer

  • All Implemented Interfaces:
    java.lang.Comparable<LfsPointer>

    public class LfsPointer
    extends java.lang.Object
    implements java.lang.Comparable<LfsPointer>
    Represents an LFS pointer file
    Since:
    4.6
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String HASH_FUNCTION_NAME
      The name of the hash function as used in the pointer files.
      private AnyLongObjectId oid  
      private long size  
      static int SIZE_THRESHOLD
      Don't inspect files that are larger than this threshold to avoid excessive reading.
      static java.lang.String VERSION
      The version of the LfsPointer file format
      static java.lang.String VERSION_LEGACY
      The version of the LfsPointer file format using legacy URL
    • Constructor Summary

      Constructors 
      Constructor Description
      LfsPointer​(AnyLongObjectId oid, long size)
      Constructor for LfsPointer.
    • Field Detail

      • VERSION

        public static final java.lang.String VERSION
        The version of the LfsPointer file format
        See Also:
        Constant Field Values
      • VERSION_LEGACY

        public static final java.lang.String VERSION_LEGACY
        The version of the LfsPointer file format using legacy URL
        Since:
        4.7
        See Also:
        Constant Field Values
      • SIZE_THRESHOLD

        public static final int SIZE_THRESHOLD
        Don't inspect files that are larger than this threshold to avoid excessive reading. No pointer file should be larger than this.
        Since:
        4.11
        See Also:
        Constant Field Values
      • HASH_FUNCTION_NAME

        public static final java.lang.String HASH_FUNCTION_NAME
        The name of the hash function as used in the pointer files. This will evaluate to "sha256"
      • size

        private long size
    • Constructor Detail

      • LfsPointer

        public LfsPointer​(AnyLongObjectId oid,
                          long size)

        Constructor for LfsPointer.

        Parameters:
        oid - the id of the content
        size - the size of the content
    • Method Detail

      • getOid

        public AnyLongObjectId getOid()

        Getter for the field oid.

        Returns:
        the id of the content
      • getSize

        public long getSize()

        Getter for the field size.

        Returns:
        the size of the content
      • encode

        public void encode​(java.io.OutputStream out)
        Encode this object into the LFS format defined by VERSION
        Parameters:
        out - the OutputStream into which the encoded data should be written
      • parseLfsPointer

        @Nullable
        public static LfsPointer parseLfsPointer​(java.io.InputStream in)
                                          throws java.io.IOException
        Try to parse the data provided by an InputStream to the format defined by VERSION
        Parameters:
        in - the InputStream from where to read the data
        Returns:
        an LfsPointer or null if the stream was not parseable as LfsPointer
        Throws:
        java.io.IOException
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • compareTo

        public int compareTo​(LfsPointer o)
        Specified by:
        compareTo in interface java.lang.Comparable<LfsPointer>
        Since:
        4.11