Class LfsPointer

    • Field Detail

      • VERSION_LEGACY

        public static final 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 String HASH_FUNCTION_NAME
        The name of the hash function as used in the pointer files. This will evaluate to "sha256"
    • 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​(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​(InputStream in)
                                          throws IOException
        Try to parse the data provided by an InputStream to the format defined by VERSION. If the given stream supports mark and reset as indicated by InputStream.markSupported(), its input position will be reset if the stream content is not actually a LFS pointer (i.e., when null is returned). If the stream content is an invalid LFS pointer or the given stream does not support mark/reset, the input position may not be reset.
        Parameters:
        in - the InputStream from where to read the data
        Returns:
        an LfsPointer or null if the stream was not parseable as LfsPointer
        Throws:
        IOException
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object