JGit 7.2.0.202503040940-r · org.eclipse.jgit.lfs.LfsPointer

Modifier and Type	Field and Description
pack-priv static final int	FULL_SIZE_THRESHOLD `SIZE_THRESHOLD` is too low; with lfs extensions a LFS pointer can be larger.
public static final String	HASH_FUNCTION_NAME The name of the hash function as used in the pointer files.
private final AnyLongObjectId	oid
private final long	size
public static final int	SIZE_THRESHOLD Don't inspect files that are larger than this threshold to avoid excessive reading.
public static final String	VERSION The version of the LfsPointer file format
public static final String	VERSION_LEGACY The version of the LfsPointer file format using legacy URL

Access	Constructor and Description
public	LfsPointer(AnyLongObjectId the id of the content oid, long the size of the content size) Constructor for LfsPointer.

Method Summary

Modifier and Type	Method and Description
private static boolean	checkVersion(byte[] data)
private static boolean	checkVersionLine(String s)
public int	compareTo(LfsPointer the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public void	encode(OutputStream the `java.io.OutputStream` into which the encoded data should be written out) Encode this object into the LFS format defined by `VERSION`
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public AnyLongObjectId	Returns: the id of the content getOid() Getter for the field `oid`.
public long	Returns: the size of the content getSize() Getter for the field `size`.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private static LfsPointer	parse(InputStream in)
private static LfsPointer	parse(BufferedReader r)
public static LfsPointer	Returns: an `org.eclipse.jgit.lfs.LfsPointer` or `null` if the stream was not parseable as LfsPointer parseLfsPointer(InputStream the `java.io.InputStream` from where to read the data in) Try to parse the data provided by an InputStream to the format defined by `VERSION`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

FULL_SIZE_THRESHOLD	back to summary
pack-priv static final int FULL_SIZE_THRESHOLD `SIZE_THRESHOLD` is too low; with lfs extensions a LFS pointer can be larger. But 8kB should be more than enough.

HASH_FUNCTION_NAME	back to summary
public static final String HASH_FUNCTION_NAME The name of the hash function as used in the pointer files. This will evaluate to "sha256"

oid	back to summary
private final AnyLongObjectId oid

size	back to summary
private final long size

SIZE_THRESHOLD	back to summary
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

VERSION	back to summary
public static final String VERSION The version of the LfsPointer file format

VERSION_LEGACY	back to summary
public static final String VERSION_LEGACY The version of the LfsPointer file format using legacy URL Since 4.7

LfsPointer	back to summary
public LfsPointer(AnyLongObjectId oid, long size) Constructor for LfsPointer. Parameters oid:AnyLongObjectId the id of the content size:long the size of the content

Method Detail

checkVersion	back to summary
private static boolean checkVersion(byte[] data)

checkVersionLine	back to summary
private static boolean checkVersionLine(String s)

compareTo back to summary

compareTo	back to summary
public int compareTo(LfsPointer o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:LfsPointer the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override Since 4.11

public int compareTo(LfsPointer o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:LfsPointer: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

Since

4.11

encode back to summary

encode	back to summary
public void encode(OutputStream out) Encode this object into the LFS format defined by `VERSION` Parameters out:OutputStream the `java.io.OutputStream` into which the encoded data should be written

public void encode(OutputStream out)

Encode this object into the LFS format defined by VERSION

Parameters

out:OutputStream: the java.io.OutputStream into which the encoded data should be written

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getOid back to summary

getOid	back to summary
public AnyLongObjectId getOid() Getter for the field `oid`. Returns:AnyLongObjectId the id of the content

public AnyLongObjectId getOid()

Getter for the field oid.

Returns:AnyLongObjectId: the id of the content

getSize back to summary

getSize	back to summary
public long getSize() Getter for the field `size`. Returns:long the size of the content

public long getSize()

Getter for the field size.

Returns:long: the size of the content

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

parse	back to summary
private static LfsPointer parse(InputStream in) throws IOException Annotations @Nullable

parse	back to summary
private static LfsPointer parse(BufferedReader r) throws IOException

parseLfsPointer back to summary

parseLfsPointer	back to summary
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:InputStream the `java.io.InputStream` from where to read the data Returns:LfsPointer an `org.eclipse.jgit.lfs.LfsPointer` or `null` if the stream was not parseable as LfsPointer Annotations @Nullable Exceptions IOException: if an IO error occurred

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:InputStream: the java.io.InputStream from where to read the data

Returns:LfsPointer

an org.eclipse.jgit.lfs.LfsPointer or null if the stream was not parseable as LfsPointer

Annotations

@Nullable

Exceptions

IOException:: if an IO error occurred

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class LfsPointer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail