Package org.eclipse.jgit.lfs
Class LfsPointer
- java.lang.Object
-
- org.eclipse.jgit.lfs.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 formatstatic 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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(LfsPointer o)
void
encode(java.io.OutputStream out)
Encode this object into the LFS format defined byVERSION
AnyLongObjectId
getOid()
Getter for the fieldoid
.long
getSize()
Getter for the fieldsize
.static LfsPointer
parseLfsPointer(java.io.InputStream in)
Try to parse the data provided by an InputStream to the format defined byVERSION
java.lang.String
toString()
-
-
-
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"
-
oid
private AnyLongObjectId oid
-
size
private long size
-
-
Constructor Detail
-
LfsPointer
public LfsPointer(AnyLongObjectId oid, long size)
Constructor for LfsPointer.
- Parameters:
oid
- the id of the contentsize
- 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 byVERSION
- Parameters:
out
- theOutputStream
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 byVERSION
- Parameters:
in
- theInputStream
from where to read the data- Returns:
- an
LfsPointer
ornull
if the stream was not parseable as LfsPointer - Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
compareTo
public int compareTo(LfsPointer o)
- Specified by:
compareTo
in interfacejava.lang.Comparable<LfsPointer>
- Since:
- 4.11
-
-