Class RefDirectory
- java.lang.Object
-
- org.eclipse.jgit.lib.RefDatabase
-
- org.eclipse.jgit.internal.storage.file.RefDirectory
-
public class RefDirectory extends RefDatabase
Traditional file system basedRefDatabase
.This is the classical reference database representation for a Git repository. References are stored in two formats: loose, and packed.
Loose references are stored as individual files within the
refs/
directory. The file name matches the reference name and the file contents is the currentObjectId
in string form.Packed references are stored in a single text file named
packed-refs
. In the packed format, each reference is stored on its own line. This file reduces the number of files needed for large reference spaces, reducing the overall size of a Git repository on disk.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PACKED_REFS_HEADER
Magic string denoting the header of a packed-refs file.static java.lang.String
PACKED_REFS_PEELED
If in the header, denotes the file has peeled data.static java.lang.String
SYMREF
Magic string denoting the start of a symbolic reference file.-
Fields inherited from class org.eclipse.jgit.lib.RefDatabase
ALL, MAX_SYMBOLIC_REF_DEPTH, SEARCH_PATH
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Close any resources held by this database.void
create()
Initialize a new reference database at this location.java.util.List<Ref>
getAdditionalRefs()
Get the additional reference-like entities from the repository.Ref
getRef(java.lang.String needle)
Read a single reference.java.util.Map<java.lang.String,Ref>
getRefs(java.lang.String prefix)
Get a section of the reference namespace.boolean
isNameConflicting(java.lang.String name)
Determine if a proposed reference name overlaps with an existing one.org.eclipse.jgit.internal.storage.file.RefDirectoryRename
newRename(java.lang.String fromName, java.lang.String toName)
Create a new update command to rename a reference.org.eclipse.jgit.internal.storage.file.RefDirectoryUpdate
newUpdate(java.lang.String name, boolean detach)
Create a new update command to create, modify or delete a reference.void
pack(java.util.List<java.lang.String> refs)
Adds a set of refs to the set of packed-refs.Ref
peel(Ref ref)
Peel a possibly unpeeled reference by traversing the annotated tags.void
refresh()
Triggers a refresh of all internal data structures.-
Methods inherited from class org.eclipse.jgit.lib.RefDatabase
findRef, getConflictingNames, newBatchUpdate, performsAtomicTransactions
-
-
-
-
Field Detail
-
SYMREF
public static final java.lang.String SYMREF
Magic string denoting the start of a symbolic reference file.- See Also:
- Constant Field Values
-
PACKED_REFS_HEADER
public static final java.lang.String PACKED_REFS_HEADER
Magic string denoting the header of a packed-refs file.- See Also:
- Constant Field Values
-
PACKED_REFS_PEELED
public static final java.lang.String PACKED_REFS_PEELED
If in the header, denotes the file has peeled data.- See Also:
- Constant Field Values
-
-
Method Detail
-
create
public void create() throws java.io.IOException
Description copied from class:RefDatabase
Initialize a new reference database at this location.- Specified by:
create
in classRefDatabase
- Throws:
java.io.IOException
- the database could not be created.
-
close
public void close()
Description copied from class:RefDatabase
Close any resources held by this database.- Specified by:
close
in classRefDatabase
-
refresh
public void refresh()
Description copied from class:RefDatabase
Triggers a refresh of all internal data structures.In case the RefDatabase implementation has internal caches this method will trigger that all these caches are cleared.
Implementors should overwrite this method if they use any kind of caches.
- Overrides:
refresh
in classRefDatabase
-
isNameConflicting
public boolean isNameConflicting(java.lang.String name) throws java.io.IOException
Description copied from class:RefDatabase
Determine if a proposed reference name overlaps with an existing one.Reference names use '/' as a component separator, and may be stored in a hierarchical storage such as a directory on the local filesystem.
If the reference "refs/heads/foo" exists then "refs/heads/foo/bar" must not exist, as a reference cannot have a value and also be a container for other references at the same time.
If the reference "refs/heads/foo/bar" exists than the reference "refs/heads/foo" cannot exist, for the same reason.
- Specified by:
isNameConflicting
in classRefDatabase
- Parameters:
name
- proposed name.- Returns:
- true if the name overlaps with an existing reference; false if using this name right now would be safe.
- Throws:
java.io.IOException
- the database could not be read to check for conflicts.- See Also:
RefDatabase.getConflictingNames(String)
-
getRef
public Ref getRef(java.lang.String needle) throws java.io.IOException
Description copied from class:RefDatabase
Read a single reference.Aside from taking advantage of
RefDatabase.SEARCH_PATH
, this method may be able to more quickly resolve a single reference name than obtaining the complete namespace bygetRefs(ALL).get(name)
.- Specified by:
getRef
in classRefDatabase
- Parameters:
needle
- the name of the reference. May be a short name which must be searched for using the standardRefDatabase.SEARCH_PATH
.- Returns:
- the reference (if it exists); else
null
. - Throws:
java.io.IOException
- the reference space cannot be accessed.
-
getRefs
public java.util.Map<java.lang.String,Ref> getRefs(java.lang.String prefix) throws java.io.IOException
Description copied from class:RefDatabase
Get a section of the reference namespace.- Specified by:
getRefs
in classRefDatabase
- Parameters:
prefix
- prefix to search the namespace with; must end with/
. If the empty string (RefDatabase.ALL
), obtain a complete snapshot of all references.- Returns:
- modifiable map that is a complete snapshot of the current
reference namespace, with
prefix
removed from the start of each key. The map can be an unsorted map. - Throws:
java.io.IOException
- the reference space cannot be accessed.
-
getAdditionalRefs
public java.util.List<Ref> getAdditionalRefs() throws java.io.IOException
Description copied from class:RefDatabase
Get the additional reference-like entities from the repository.The result list includes non-ref items such as MERGE_HEAD and FETCH_RESULT cast to be refs. The names of these refs are not returned by
getRefs(ALL)
but are accepted byRefDatabase.getRef(String)
- Specified by:
getAdditionalRefs
in classRefDatabase
- Returns:
- a list of additional refs
- Throws:
java.io.IOException
- the reference space cannot be accessed.
-
peel
public Ref peel(Ref ref) throws java.io.IOException
Description copied from class:RefDatabase
Peel a possibly unpeeled reference by traversing the annotated tags.If the reference cannot be peeled (as it does not refer to an annotated tag) the peeled id stays null, but
Ref.isPeeled()
will be true.Implementors should check
Ref.isPeeled()
before performing any additional work effort.- Specified by:
peel
in classRefDatabase
- Parameters:
ref
- The reference to peel- Returns:
ref
ifref.isPeeled()
is true; otherwise a new Ref object representing the same data as Ref, but isPeeled() will be true and getPeeledObjectId() will contain the peeled object (or null).- Throws:
java.io.IOException
- the reference space or object space cannot be accessed.
-
newUpdate
public org.eclipse.jgit.internal.storage.file.RefDirectoryUpdate newUpdate(java.lang.String name, boolean detach) throws java.io.IOException
Description copied from class:RefDatabase
Create a new update command to create, modify or delete a reference.- Specified by:
newUpdate
in classRefDatabase
- Parameters:
name
- the name of the reference.detach
- iftrue
andname
is currently aSymbolicRef
, the update will replace it with anObjectIdRef
. Otherwise, the update will recursively traverseSymbolicRef
s and operate on the leafObjectIdRef
.- Returns:
- a new update for the requested name; never null.
- Throws:
java.io.IOException
- the reference space cannot be accessed.
-
newRename
public org.eclipse.jgit.internal.storage.file.RefDirectoryRename newRename(java.lang.String fromName, java.lang.String toName) throws java.io.IOException
Description copied from class:RefDatabase
Create a new update command to rename a reference.- Specified by:
newRename
in classRefDatabase
- Parameters:
fromName
- name of reference to rename fromtoName
- name of reference to rename to- Returns:
- an update command that knows how to rename a branch to another.
- Throws:
java.io.IOException
- the reference space cannot be accessed.
-
pack
public void pack(java.util.List<java.lang.String> refs) throws java.io.IOException
Adds a set of refs to the set of packed-refs. Only non-symbolic refs are added. If a ref with the given name already existed in packed-refs it is updated with the new value. Each loose ref which was added to the packed-ref file is deleted. If a given ref can't be locked it will not be added to the pack file.- Parameters:
refs
- the refs to be added. Must be fully qualified.- Throws:
java.io.IOException
-
-