Class ObjectIdRef
- java.lang.Object
-
- org.eclipse.jgit.lib.ObjectIdRef
-
- All Implemented Interfaces:
Ref
- Direct Known Subclasses:
ObjectIdRef.PeeledNonTag
,ObjectIdRef.PeeledTag
,ObjectIdRef.Unpeeled
public abstract class ObjectIdRef extends Object implements Ref
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ObjectIdRef.PeeledNonTag
A reference to a non-tag object coming from a cached source.static class
ObjectIdRef.PeeledTag
An annotated tag whose peeled object has been cached.static class
ObjectIdRef.Unpeeled
Any reference whose peeled value is not yet known.-
Nested classes/interfaces inherited from interface org.eclipse.jgit.lib.Ref
Ref.Storage
-
-
Field Summary
-
Fields inherited from interface org.eclipse.jgit.lib.Ref
UNDEFINED_UPDATE_INDEX
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ObjectIdRef(Ref.Storage st, String name, ObjectId id, long updateIndex)
Create a new ref pairing.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ref
getLeaf()
Traverse target references untilRef.isSymbolic()
is false.String
getName()
What this ref is called within the repository.ObjectId
getObjectId()
Cached value of this ref.Ref.Storage
getStorage()
How was this ref obtained?Ref
getTarget()
Get the reference this reference points to, orthis
.long
getUpdateIndex()
Indicator of the relative order between updates of a specific reference name.boolean
isSymbolic()
Test if this reference is a symbolic reference.String
toString()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jgit.lib.Ref
getPeeledObjectId, isPeeled
-
-
-
-
Constructor Detail
-
ObjectIdRef
protected ObjectIdRef(@NonNull Ref.Storage st, @NonNull String name, @Nullable ObjectId id, long updateIndex)
Create a new ref pairing.- Parameters:
st
- method used to store this ref.name
- name of this ref.id
- current value of the ref. May benull
to indicate a ref that does not exist yet.updateIndex
- number that increases with each ref update. Set to -1 if the storage doesn't support versioning.- Since:
- 5.3
-
-
Method Detail
-
isSymbolic
public boolean isSymbolic()
Test if this reference is a symbolic reference.A symbolic reference does not have its own
ObjectId
value, but instead points to anotherRef
in the same database and always uses that other reference's value as its own.- Specified by:
isSymbolic
in interfaceRef
- Returns:
- true if this is a symbolic reference; false if this reference contains its own ObjectId.
-
getLeaf
@NonNull public Ref getLeaf()
Traverse target references untilRef.isSymbolic()
is false.If
Ref.isSymbolic()
is false, returnsthis
.If
Ref.isSymbolic()
is true, this method recursively traversesRef.getTarget()
untilRef.isSymbolic()
returns false.This method is effectively
return isSymbolic() ? getTarget().getLeaf() : this;
-
getTarget
@NonNull public Ref getTarget()
Get the reference this reference points to, orthis
.If
Ref.isSymbolic()
is true this method returns the reference it directly names, which might not be the leaf reference, but could be another symbolic reference.If this is a leaf level reference that contains its own ObjectId,this method returns
this
.
-
getObjectId
@Nullable public ObjectId getObjectId()
Cached value of this ref.- Specified by:
getObjectId
in interfaceRef
- Returns:
- the value of this ref at the last time we read it. May be
null
to indicate a ref that does not exist yet or a symbolic ref pointing to an unborn branch.
-
getStorage
@NonNull public Ref.Storage getStorage()
How was this ref obtained?The current storage model of a Ref may influence how the ref must be updated or deleted from the repository.
- Specified by:
getStorage
in interfaceRef
- Returns:
- type of ref.
-
getUpdateIndex
public long getUpdateIndex()
Indicator of the relative order between updates of a specific reference name. A number that increases when a reference is updated.With symbolic references, the update index refers to updates of the symbolic reference itself. For example, if HEAD points to refs/heads/master, then the update index for exactRef("HEAD") will only increase when HEAD changes to point to another ref, regardless of how many times refs/heads/master is updated.
Should not be used unless the
RefDatabase
that instantiated the ref supports versioning (seeRefDatabase.hasVersioning()
)- Specified by:
getUpdateIndex
in interfaceRef
- Returns:
- the update index (i.e. version) of this reference.
- Since:
- 5.3
-
-