JGit 7.2.0.202503040940-r · org.eclipse.jgit.lib.FileMode

Field Summary

Modifier and Type	Field and Description
public static final FileMode	EXECUTABLE_FILE Mode indicating an entry is an executable file.
public static final FileMode	GITLINK Mode indicating an entry is a submodule commit in another repository.
public static final FileMode	MISSING Mode indicating an entry is missing during parallel walks.
private final int	modeBits
private final int	objectType
private final byte[]	octalBytes
public static final FileMode	REGULAR_FILE Mode indicating an entry is a non-executable file.
public static final FileMode	SYMLINK Mode indicating an entry is a symbolic link.
public static final FileMode	TREE Mode indicating an entry is a tree (aka directory).
public static final int	TYPE_FILE Bit pattern for `TYPE_MASK` matching `REGULAR_FILE`.
public static final int	TYPE_GITLINK Bit pattern for `TYPE_MASK` matching `GITLINK`.
public static final int	TYPE_MASK Mask to apply to a file mode to obtain its type bits.
public static final int	TYPE_MISSING Bit pattern for `TYPE_MASK` matching `MISSING`.
public static final int	TYPE_SYMLINK Bit pattern for `TYPE_MASK` matching `SYMLINK`.
public static final int	TYPE_TREE Bit pattern for `TYPE_MASK` matching `TREE`.

Access	Constructor and Description
private	FileMode(int mode, int expType)

Method Summary

Modifier and Type	Method and Description
public void	copyTo(OutputStream stream to copy the mode to. os) Copy this mode as a sequence of octal US-ASCII bytes.
public void	copyTo(byte[] buffer to copy the mode to. buf, int position within `buf` for first digit. ptr) Copy this mode as a sequence of octal US-ASCII bytes.
public int	Returns: the number of bytes written by `copyTo(OutputStream)`. copyToLength() Copy the number of bytes written by `copyTo(OutputStream)`.
public abstract boolean	Returns: true if the mode bits represent the same mode as this object equals(int a int. modeBits) Test a file mode for equality with this `org.eclipse.jgit.lib.FileMode` object.
public static final FileMode	Returns: the FileMode instance that represents the given bits. fromBits(int the mode bits the caller has somehow obtained. bits) Convert a set of mode bits into a FileMode enumerated value.
public int	Returns: The mode bits as an integer. getBits() Get the mode bits as an integer.
public int	Returns: one of the well known object type constants. getObjectType() Get the object type that should appear for this type of mode.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

EXECUTABLE_FILE	back to summary
public static final FileMode EXECUTABLE_FILE Mode indicating an entry is an executable file.

GITLINK	back to summary
public static final FileMode GITLINK Mode indicating an entry is a submodule commit in another repository.

MISSING	back to summary
public static final FileMode MISSING Mode indicating an entry is missing during parallel walks.

modeBits	back to summary
private final int modeBits

objectType	back to summary
private final int objectType

octalBytes	back to summary
private final byte[] octalBytes

REGULAR_FILE	back to summary
public static final FileMode REGULAR_FILE Mode indicating an entry is a non-executable file.

SYMLINK	back to summary
public static final FileMode SYMLINK Mode indicating an entry is a symbolic link.

TREE	back to summary
public static final FileMode TREE Mode indicating an entry is a tree (aka directory).

TYPE_FILE	back to summary
public static final int TYPE_FILE Bit pattern for `TYPE_MASK` matching `REGULAR_FILE`.

TYPE_GITLINK	back to summary
public static final int TYPE_GITLINK Bit pattern for `TYPE_MASK` matching `GITLINK`.

TYPE_MASK back to summary

TYPE_MASK	back to summary
public static final int TYPE_MASK Mask to apply to a file mode to obtain its type bits. See Also `TYPE_TREE`, `TYPE_SYMLINK`, `TYPE_FILE`, `TYPE_GITLINK`, `TYPE_MISSING`

public static final int TYPE_MASK

Mask to apply to a file mode to obtain its type bits.

See Also: TYPE_TREE, TYPE_SYMLINK, TYPE_FILE, TYPE_GITLINK, TYPE_MISSING

TYPE_MISSING	back to summary
public static final int TYPE_MISSING Bit pattern for `TYPE_MASK` matching `MISSING`.

TYPE_SYMLINK	back to summary
public static final int TYPE_SYMLINK Bit pattern for `TYPE_MASK` matching `SYMLINK`.

TYPE_TREE	back to summary
public static final int TYPE_TREE Bit pattern for `TYPE_MASK` matching `TREE`.

Constructor Detail

FileMode	back to summary
private FileMode(int mode, int expType)

Method Detail

copyTo	back to summary
public void copyTo(OutputStream os) throws IOException Copy this mode as a sequence of octal US-ASCII bytes. The mode is copied as a sequence of octal digits using the US-ASCII character encoding. The sequence does not use a leading '0' prefix to indicate octal notation. This method is suitable for generation of a mode string within a GIT tree object. Parameters os:OutputStream stream to copy the mode to. Exceptions IOException: the stream encountered an error during the copy.

copyTo

back to summary

public void copyTo(OutputStream os) throws IOException

Copy this mode as a sequence of octal US-ASCII bytes.

The mode is copied as a sequence of octal digits using the US-ASCII character encoding. The sequence does not use a leading '0' prefix to indicate octal notation. This method is suitable for generation of a mode string within a GIT tree object.

Parameters

os:OutputStream: stream to copy the mode to.

Exceptions

IOException:: the stream encountered an error during the copy.

copyTo back to summary

copyTo	back to summary
public void copyTo(byte[] buf, int ptr) Copy this mode as a sequence of octal US-ASCII bytes. The mode is copied as a sequence of octal digits using the US-ASCII character encoding. The sequence does not use a leading '0' prefix to indicate octal notation. This method is suitable for generation of a mode string within a GIT tree object. Parameters buf:byte[] buffer to copy the mode to. ptr:int position within `buf` for first digit.

public void copyTo(byte[] buf, int ptr)

Copy this mode as a sequence of octal US-ASCII bytes. The mode is copied as a sequence of octal digits using the US-ASCII character encoding. The sequence does not use a leading '0' prefix to indicate octal notation. This method is suitable for generation of a mode string within a GIT tree object.

Parameters

buf:byte[]: buffer to copy the mode to.
ptr:int: position within buf for first digit.

copyToLength back to summary

copyToLength	back to summary
public int copyToLength() Copy the number of bytes written by `copyTo(OutputStream)`. Returns:int the number of bytes written by `copyTo(OutputStream)`.

public int copyToLength()

Copy the number of bytes written by copyTo(OutputStream).

Returns:int: the number of bytes written by copyTo(OutputStream).

equals back to summary

equals	back to summary
public abstract boolean equals(int modeBits) Test a file mode for equality with this `org.eclipse.jgit.lib.FileMode` object. Parameters modeBits:int a int. Returns:boolean true if the mode bits represent the same mode as this object Annotations @SuppressWarnings:NonOverridingEquals

public abstract boolean equals(int modeBits)

Test a file mode for equality with this org.eclipse.jgit.lib.FileMode object.

Parameters

modeBits:int: a int.

Returns:boolean

true if the mode bits represent the same mode as this object

Annotations

@SuppressWarnings:NonOverridingEquals

fromBits	back to summary
public static final FileMode fromBits(int bits) Convert a set of mode bits into a FileMode enumerated value. Parameters bits:int the mode bits the caller has somehow obtained. Returns:FileMode the FileMode instance that represents the given bits.

fromBits

back to summary

public static final FileMode fromBits(int bits)

Convert a set of mode bits into a FileMode enumerated value.

Parameters

bits:int: the mode bits the caller has somehow obtained.

Returns:FileMode

the FileMode instance that represents the given bits.

getBits	back to summary
public int getBits() Get the mode bits as an integer. Returns:int The mode bits as an integer.

getBits

back to summary

public int getBits()

Get the mode bits as an integer.

Returns:int: The mode bits as an integer.

getObjectType back to summary

getObjectType	back to summary
public int getObjectType() Get the object type that should appear for this type of mode. See the object type constants in `org.eclipse.jgit.lib.Constants`. Returns:int one of the well known object type constants.

public int getObjectType()

Get the object type that should appear for this type of mode.

See the object type constants in org.eclipse.jgit.lib.Constants.

Returns:int: one of the well known object type constants.

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. Format this mode as an octal string (for debugging only). 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.

Format this mode as an octal string (for debugging only).

Returns:String

a string representation of the object

Annotations

@Override

public abstract Class FileMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail