public final class Constants extends Object
Modifier and Type | Field and Description |
---|---|
static String |
ATTR_BUILTIN_BINARY_MERGER
Binary value for custom merger.
|
static String |
ATTR_DIFF
Diff attribute.
|
static String |
ATTR_FILTER
Key for filters in .gitattributes
|
static String |
ATTR_FILTER_TYPE_CLEAN
clean command name, used to call filter driver
|
static String |
ATTR_FILTER_TYPE_SMUDGE
smudge command name, used to call filter driver
|
static String |
ATTR_MERGE
Merge attribute.
|
static String |
BUILTIN_FILTER_PREFIX
Builtin filter commands start with this prefix
|
static String |
CHARACTER_ENCODING
Deprecated.
Use
StandardCharsets.UTF_8 directly
instead. |
static Charset |
CHARSET
Deprecated.
Use
StandardCharsets.UTF_8 directly
instead. |
static String |
CHERRY_PICK_HEAD
name of the file containing the ID of a cherry pick commit in case of conflicts
|
static String |
COMMIT_EDITMSG
Name of the file in which git commands and hooks store and read the
message prepared for the upcoming commit.
|
static String |
CONFIG
Default name for the Git repository configuration
|
static String |
DEFAULT_REMOTE_NAME
Default remote name used by clone, push and fetch operations
|
static String |
DOT_GIT
Default name for the Git repository directory
|
static String |
DOT_GIT_ATTRIBUTES
Name of the attributes file
|
static String |
DOT_GIT_EXT
A bare repository typically ends with this string
|
static String |
DOT_GIT_IGNORE
Name of the ignore file
|
static String |
DOT_GIT_MODULES
Name of the submodules file
|
static ObjectId |
EMPTY_BLOB_ID
Well-known object ID for the empty blob.
|
static ObjectId |
EMPTY_TREE_ID
Well-known object ID for the empty tree.
|
static String |
FETCH_HEAD
Special name for the "FETCH_HEAD" symbolic-ref.
|
static String |
GIT_ALTERNATE_OBJECT_DIRECTORIES_KEY
The environment variable that tells us where to look for objects, besides
the default objects directory.
|
static String |
GIT_AUTHOR_EMAIL_KEY
The environment variable that contains the author's email
|
static String |
GIT_AUTHOR_NAME_KEY
The environment variable that contains the author's name
|
static String |
GIT_CEILING_DIRECTORIES_KEY
The environment variable that limits how close to the root of the file
systems JGit will traverse when looking for a repository root.
|
static String |
GIT_COMMITTER_EMAIL_KEY
The environment variable that contains the commiter's email
|
static String |
GIT_COMMITTER_NAME_KEY
The environment variable that contains the commiter's name
|
static String |
GIT_CONFIG_NOSYSTEM_KEY
The environment variable that blocks use of the system config file
|
static String |
GIT_DIR_KEY
The environment variable that tells us which directory is the ".git"
directory
|
static String |
GIT_INDEX_FILE_KEY
The environment variable that tells us which file holds the Git index.
|
static String |
GIT_OBJECT_DIRECTORY_KEY
The environment variable that tells us where objects are stored
|
static String |
GIT_WORK_TREE_KEY
The environment variable that tells us which directory is the working
directory.
|
static String |
GITDIR
Prefix of the first line in a ".git" file
|
static String |
GITIGNORE_FILENAME
A gitignore file name
|
static String |
HEAD
Special name for the "HEAD" symbolic-ref.
|
static String |
HOOKS
Name of the folder (inside gitDir) where the hooks are stored.
|
static String |
INFO_ALTERNATES
Info alternates file (goes under OBJECTS)
|
static String |
INFO_ATTRIBUTES
Attributes-override-file
|
static String |
INFO_EXCLUDE
Excludes-file
|
static String |
INFO_HTTP_ALTERNATES
HTTP alternates file (goes under OBJECTS)
|
static String |
INFO_REFS
Info refs folder
|
static String |
LOCK_SUFFIX
Suffix of lock file name
|
static String |
LOGS
Logs folder name
|
static String |
MASTER
Default main branch name
|
static String |
MERGE_HEAD
name of the file containing the IDs of the parents of a merge commit
|
static String |
MERGE_MSG
name of the file containing the commit msg for a merge commit
|
static String |
MODULES
Name of the folder (inside gitDir) where submodules are stored
|
static int |
OBJ_BAD
An unknown or invalid object type code.
|
static int |
OBJ_BLOB
In-pack object type: blob.
|
static int |
OBJ_COMMIT
In-pack object type: commit.
|
static int |
OBJ_EXT
In-pack object type: extended types.
|
static int |
OBJ_OFS_DELTA
In-pack object type: offset delta
|
static int |
OBJ_REF_DELTA
In-pack object type: reference delta
|
static int |
OBJ_TAG
In-pack object type: annotated tag.
|
static int |
OBJ_TREE
In-pack object type: tree.
|
static int |
OBJ_TYPE_5
In-pack object type: reserved for future use.
|
static int |
OBJECT_ID_LENGTH
A Git object hash is 160 bits, i.e.
|
static int |
OBJECT_ID_STRING_LENGTH
A Git object can be expressed as a 40 character string of hexadecimal
digits.
|
static String |
OBJECTS
Objects folder name
|
static String |
ORIG_HEAD
name of the ref ORIG_HEAD used by certain commands to store the original
value of HEAD
|
static String |
OS_USER_DIR
The system property that contains the system user name
|
static String |
OS_USER_NAME_KEY
The system property that contains the system user name
|
static byte[] |
PACK_SIGNATURE
Pack file signature that occurs at file header - identifies file as Git
packfile formatted.
|
static String |
PACKED_REFS
Packed refs file
|
static String |
R_HEADS
Prefix for branch refs
|
static String |
R_NOTES
Prefix for notes refs
|
static String |
R_NOTES_COMMITS
Standard notes ref
|
static String |
R_REFS
Prefix for any ref
|
static String |
R_REMOTES
Prefix for remotes refs
|
static String |
R_STASH
Standard stash ref
|
static String |
R_TAGS
Prefix for tag refs
|
static String |
REFTABLE
Reftable folder name
|
static String |
REVERT_HEAD
name of the file containing the ID of a revert commit in case of conflicts
|
static String |
SHALLOW
Name of the .git/shallow file
|
static String |
SIGNED_OFF_BY_TAG
Beginning of the common "Signed-off-by: " commit message line
|
static String |
SQUASH_MSG
name of the file containing the commit msg for a squash commit
|
static String |
STASH
Default stash branch name
|
static String |
TYPE_BLOB
Text string that identifies an object as a blob.
|
static String |
TYPE_COMMIT
Text string that identifies an object as a commit.
|
static String |
TYPE_TAG
Text string that identifies an object as an annotated tag.
|
static String |
TYPE_TREE
Text string that identifies an object as a tree.
|
static String |
UNKNOWN_USER_DEFAULT
Default value for the user name if no other information is available
|
static String |
XDG_CONFIG_HOME
The key of the XDG_CONFIG_HOME directory defined in the XDG base
directory specification, see
"https://wiki.archlinux.org/index.php/XDG_Base_Directory"
|
Modifier and Type | Method and Description |
---|---|
static int |
decodeTypeString(AnyObjectId id,
byte[] typeString,
byte endMark,
MutableInteger offset)
Parse an encoded type string into a type constant.
|
static byte[] |
encode(String str)
Convert a string to a byte array in the standard character encoding.
|
static byte[] |
encodeASCII(long s)
Convert an integer into its decimal representation.
|
static byte[] |
encodeASCII(String s)
Convert a string to US-ASCII encoding.
|
static byte[] |
encodedTypeString(int typeCode)
Convert an OBJ_* type constant to an ASCII encoded string constant.
|
static MessageDigest |
newMessageDigest()
Create a new digest function for objects.
|
static String |
typeString(int typeCode)
Convert an OBJ_* type constant to a TYPE_* type constant.
|
public static final int OBJECT_ID_LENGTH
Changing this assumption is not going to be as easy as changing this declaration.
public static final int OBJECT_ID_STRING_LENGTH
OBJECT_ID_LENGTH
,
Constant Field Valuespublic static final String HEAD
public static final String FETCH_HEAD
public static final String TYPE_COMMIT
Commits connect trees into a string of project histories, where each commit is an assertion that the best way to continue is to use this other tree (set of files).
public static final String TYPE_BLOB
Blobs store whole file revisions. They are used for any user file, as well as for symlinks. Blobs form the bulk of any project's storage space.
public static final String TYPE_TREE
Trees attach object ids (hashes) to names and file modes. The normal use for a tree is to store a version of a directory and its contents.
public static final String TYPE_TAG
Annotated tags store a pointer to any other object, and an additional message. It is most commonly used to record a stable release of the project.
public static final int OBJ_BAD
public static final int OBJ_EXT
This header code is reserved for future expansion. It is currently undefined/unsupported.
public static final int OBJ_COMMIT
Indicates the associated object is a commit.
This constant is fixed and is defined by the Git packfile format.
TYPE_COMMIT
,
Constant Field Valuespublic static final int OBJ_TREE
Indicates the associated object is a tree.
This constant is fixed and is defined by the Git packfile format.
TYPE_BLOB
,
Constant Field Valuespublic static final int OBJ_BLOB
Indicates the associated object is a blob.
This constant is fixed and is defined by the Git packfile format.
TYPE_BLOB
,
Constant Field Valuespublic static final int OBJ_TAG
Indicates the associated object is an annotated tag.
This constant is fixed and is defined by the Git packfile format.
TYPE_TAG
,
Constant Field Valuespublic static final int OBJ_TYPE_5
public static final int OBJ_OFS_DELTA
Objects stored with this type actually have a different type which must be obtained from their delta base object. Delta objects store only the changes needed to apply to the base object in order to recover the original object.
An offset delta uses a negative offset from the start of this object to refer to its delta base. The base object must exist in this packfile (even in the case of a thin pack).
This constant is fixed and is defined by the Git packfile format.
public static final int OBJ_REF_DELTA
Objects stored with this type actually have a different type which must be obtained from their delta base object. Delta objects store only the changes needed to apply to the base object in order to recover the original object.
A reference delta uses a full object id (hash) to reference the delta base. The base object is allowed to be omitted from the packfile, but only in the case of a thin pack being transferred over the network.
This constant is fixed and is defined by the Git packfile format.
public static final byte[] PACK_SIGNATURE
This constant is fixed and is defined by the Git packfile format.
@Deprecated public static final Charset CHARSET
StandardCharsets.UTF_8
directly
instead.@Deprecated public static final String CHARACTER_ENCODING
StandardCharsets.UTF_8
directly
instead.public static final String MASTER
public static final String STASH
public static final String R_HEADS
public static final String R_REMOTES
public static final String R_TAGS
public static final String R_NOTES
public static final String R_NOTES_COMMITS
public static final String R_REFS
public static final String R_STASH
public static final String LOGS
public static final String OBJECTS
public static final String REFTABLE
public static final String INFO_REFS
public static final String INFO_ALTERNATES
public static final String INFO_HTTP_ALTERNATES
public static final String PACKED_REFS
public static final String INFO_EXCLUDE
public static final String INFO_ATTRIBUTES
public static final String OS_USER_DIR
public static final String OS_USER_NAME_KEY
public static final String GIT_AUTHOR_NAME_KEY
public static final String GIT_AUTHOR_EMAIL_KEY
public static final String GIT_COMMITTER_NAME_KEY
public static final String GIT_COMMITTER_EMAIL_KEY
public static final String GIT_CONFIG_NOSYSTEM_KEY
public static final String XDG_CONFIG_HOME
public static final String GIT_CEILING_DIRECTORIES_KEY
public static final String GIT_DIR_KEY
public static final String GIT_WORK_TREE_KEY
public static final String GIT_INDEX_FILE_KEY
public static final String GIT_OBJECT_DIRECTORY_KEY
public static final String GIT_ALTERNATE_OBJECT_DIRECTORIES_KEY
public static final String UNKNOWN_USER_DEFAULT
public static final String SIGNED_OFF_BY_TAG
public static final String GITIGNORE_FILENAME
public static final String DEFAULT_REMOTE_NAME
public static final String DOT_GIT
public static final String CONFIG
public static final String DOT_GIT_EXT
public static final String DOT_GIT_ATTRIBUTES
public static final String ATTR_FILTER
public static final String ATTR_FILTER_TYPE_CLEAN
public static final String ATTR_FILTER_TYPE_SMUDGE
public static final String BUILTIN_FILTER_PREFIX
public static final String DOT_GIT_IGNORE
public static final String DOT_GIT_MODULES
public static final String SHALLOW
public static final String GITDIR
public static final String MODULES
public static final String HOOKS
public static final String ATTR_MERGE
public static final String ATTR_DIFF
public static final String ATTR_BUILTIN_BINARY_MERGER
public static final String MERGE_MSG
public static final String MERGE_HEAD
public static final String CHERRY_PICK_HEAD
public static final String SQUASH_MSG
public static final String REVERT_HEAD
public static final String ORIG_HEAD
public static final String COMMIT_EDITMSG
public static final ObjectId EMPTY_BLOB_ID
public static final ObjectId EMPTY_TREE_ID
public static final String LOCK_SUFFIX
public static MessageDigest newMessageDigest()
RuntimeException
- this Java virtual machine does not support the required hash
function. Very unlikely given that JGit uses a hash function
that is in the Java reference specification.public static String typeString(int typeCode)
typeCode
- the type code, from a pack representation.public static byte[] encodedTypeString(int typeCode)
The ASCII encoded string is often the canonical representation of the type within a loose object header, or within a tag header.
typeCode
- the type code, from a pack representation.public static int decodeTypeString(AnyObjectId id, byte[] typeString, byte endMark, MutableInteger offset) throws CorruptObjectException
id
- object id this type string came from; may be null if that is
not known at the time the parse is occurring.typeString
- string version of the type code.endMark
- character immediately following the type string. Usually ' '
(space) or '\n' (line feed).offset
- position within typeString
where the parse
should start. Updated with the new position (just past
endMark
when the parse is successful.OBJ_BLOB
,
OBJ_COMMIT
, OBJ_TAG
, OBJ_TREE
.CorruptObjectException
- there is no valid type identified by typeString
.public static byte[] encodeASCII(long s)
s
- the integer to convert.public static byte[] encodeASCII(String s)
s
- the string to convert. Must not contain any characters over
127 (outside of 7-bit ASCII).IllegalArgumentException
- the input string contains one or more characters outside of
the 7-bit ASCII character space.public static byte[] encode(String str)
str
- the string to convert. May contain any Unicode characters.CHARACTER_ENCODING
Copyright © 2020 Eclipse JGit Project. All rights reserved.