Uses of Interface
org.eclipse.jgit.lib.Ref

Packages that use Ref

Package	Description
org.eclipse.jgit.api	High-level API commands (the porcelain of JGit).
org.eclipse.jgit.api.errors	Exceptions thrown by API commands.
org.eclipse.jgit.internal.ketch	Distributed consensus system built on Git.
org.eclipse.jgit.internal.storage.dfs	Distributed file system based repository storage.
org.eclipse.jgit.internal.storage.file	File based repository storage.
org.eclipse.jgit.internal.storage.reftable
org.eclipse.jgit.internal.storage.reftree
org.eclipse.jgit.lib	Core API for repository, config, refs, object database.
org.eclipse.jgit.merge	Content and commit history merge algorithms.
org.eclipse.jgit.revplot	Building/rendering revision graphs.
org.eclipse.jgit.revwalk	Walking revision graphs (commit history).
org.eclipse.jgit.transport	Transport (fetch/push) for different protocols.
org.eclipse.jgit.util	Utility classes.

Uses of Ref in org.eclipse.jgit.api

Methods in org.eclipse.jgit.api that return Ref

Modifier and Type	Method and Description
Ref	ResetCommand.call()
Ref	CreateBranchCommand.call()
Ref	TagCommand.call()
Ref	RenameBranchCommand.call()
Ref	CheckoutCommand.call()

Methods in org.eclipse.jgit.api that return types with arguments of type Ref

Modifier and Type	Method and Description
List<Ref>	ListBranchCommand.call()
Collection<Ref>	LsRemoteCommand.call()
List<Ref>	ListTagCommand.call()
Map<String,Ref>	LsRemoteCommand.callAsMap() Same as LsRemoteCommand.call(), but return Map instead of Collection.
List<Ref>	CherryPickResult.getCherryPickedRefs() Get the cherry-picked Refs
List<Ref>	RevertCommand.getRevertedRefs() Get the list of successfully reverted Ref's.

Methods in org.eclipse.jgit.api with parameters of type Ref

Modifier and Type	Method and Description
PushCommand	PushCommand.add(Ref ref) Add a reference to push.
NameRevCommand	NameRevCommand.addRef(Ref ref) Add a ref to the set that all results must match.
CherryPickCommand	CherryPickCommand.include(Ref commit) Include a reference to a commit
MergeCommand	MergeCommand.include(Ref aCommit) Reference to a commit to be merged with the current head
RevertCommand	RevertCommand.include(Ref commit) Include a Ref to a commit to be reverted

Constructor parameters in org.eclipse.jgit.api with type arguments of type Ref

Constructor and Description
CherryPickResult(RevCommit newHead, List<Ref> cherryPickedRefs) Constructor for CherryPickResult

Uses of Ref in org.eclipse.jgit.api.errors

Methods in org.eclipse.jgit.api.errors that return Ref

Modifier and Type	Method and Description
Ref	ConcurrentRefUpdateException.getRef() Get Ref

Constructors in org.eclipse.jgit.api.errors with parameters of type Ref

Constructor and Description
ConcurrentRefUpdateException(String message, Ref ref, RefUpdate.Result rc) Constructor for ConcurrentRefUpdateException.
ConcurrentRefUpdateException(String message, Ref ref, RefUpdate.Result rc, Throwable cause) Constructor for ConcurrentRefUpdateException.

Uses of Ref in org.eclipse.jgit.internal.ketch

Methods in org.eclipse.jgit.internal.ketch that return types with arguments of type Ref

Modifier and Type	Method and Description
Map<String,Ref>	ReplicaFetchRequest.getRefs() Get remote references, usually from the advertisement.
Map<String,Ref>	ReplicaPushRequest.getRefs() Get remote references, usually from the advertisement.

Method parameters in org.eclipse.jgit.internal.ketch with type arguments of type Ref

Modifier and Type	Method and Description
protected Collection<ReceiveCommand>	KetchReplica.prepareCommit(Repository git, Map<String,Ref> current, ObjectId committed) Build a list of commands to commit KetchReplica.CommitMethod.ALL_REFS.
void	ReplicaFetchRequest.setRefs(Map<String,Ref> refs) Set references observed from the replica.
void	ReplicaPushRequest.setRefs(Map<String,Ref> refs) Set references observed from the replica.

Uses of Ref in org.eclipse.jgit.internal.storage.dfs

Methods in org.eclipse.jgit.internal.storage.dfs that return Ref

Modifier and Type	Method and Description
Ref	DfsReftableDatabase.exactRef(String name) Read a single reference.
Ref	DfsRefDatabase.exactRef(String name) Read a single reference.
Ref	DfsRefDatabase.RefCache.get(String name) Find a reference by name.
Ref	DfsReftableDatabase.getRef(String needle) Read a single reference.
Ref	DfsRefDatabase.getRef(String needle) Read a single reference.
Ref	DfsReftableDatabase.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.
Ref	DfsRefDatabase.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.

Methods in org.eclipse.jgit.internal.storage.dfs that return types with arguments of type Ref

Modifier and Type	Method and Description
List<Ref>	DfsRefDatabase.getAdditionalRefs() Get the additional reference-like entities from the repository.
Map<String,Ref>	DfsReftableDatabase.getRefs(String prefix) Get a section of the reference namespace.
Map<String,Ref>	DfsRefDatabase.getRefs(String prefix) Get a section of the reference namespace.

Methods in org.eclipse.jgit.internal.storage.dfs with parameters of type Ref

Modifier and Type	Method and Description
protected void	DfsReftableDatabase.cachePeeledState(Ref oldLeaf, Ref newLeaf) Update the cached peeled state of a reference
protected void	DfsRefDatabase.cachePeeledState(Ref oldLeaf, Ref newLeaf) Update the cached peeled state of a reference
protected boolean	DfsReftableDatabase.compareAndPut(Ref oldRef, Ref newRef) Compare a reference, and put if it matches.
protected abstract boolean	DfsRefDatabase.compareAndPut(Ref oldRef, Ref newRef) Compare a reference, and put if it matches.
protected boolean	DfsReftableDatabase.compareAndRemove(Ref oldRef) Compare a reference, and delete if it matches.
protected abstract boolean	DfsRefDatabase.compareAndRemove(Ref oldRef) Compare a reference, and delete if it matches.
Ref	DfsReftableDatabase.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.
Ref	DfsRefDatabase.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.
DfsRefDatabase.RefCache	DfsRefDatabase.RefCache.put(Ref ref) Obtain a modified copy of the cache with a ref stored.

Constructor parameters in org.eclipse.jgit.internal.storage.dfs with type arguments of type Ref

Constructor and Description
RefCache(RefList<Ref> ids, RefList<Ref> sym) Initialize a new reference cache.
RefCache(RefList<Ref> ids, RefList<Ref> sym) Initialize a new reference cache.

Uses of Ref in org.eclipse.jgit.internal.storage.file

Methods in org.eclipse.jgit.internal.storage.file that return Ref

Modifier and Type	Method and Description
Ref	RefDirectory.exactRef(String name) Read a single reference.
Ref	RefDirectory.getRef(String needle) Read a single reference.
Ref	RefDirectory.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.

Methods in org.eclipse.jgit.internal.storage.file that return types with arguments of type Ref

Modifier and Type	Method and Description
List<Ref>	RefDirectory.getAdditionalRefs() Get the additional reference-like entities from the repository.
Map<String,Ref>	RefDirectory.getRefs(String prefix) Get a section of the reference namespace.

Methods in org.eclipse.jgit.internal.storage.file with parameters of type Ref

Modifier and Type	Method and Description
Ref	RefDirectory.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.

Uses of Ref in org.eclipse.jgit.internal.storage.reftable

Methods in org.eclipse.jgit.internal.storage.reftable that return Ref

Modifier and Type	Method and Description
Ref	Reftable.exactRef(String refName) Lookup a reference, or null if not found.
abstract Ref	RefCursor.getRef() Get reference at the current position.
Ref	Reftable.resolve(Ref symref) Resolve a symbolic reference to populate its value.

Methods in org.eclipse.jgit.internal.storage.reftable with parameters of type Ref

Modifier and Type	Method and Description
Ref	Reftable.resolve(Ref symref) Resolve a symbolic reference to populate its value.
void	ReftableWriter.writeRef(Ref ref) Write one reference to the reftable.
void	ReftableWriter.writeRef(Ref ref, long updateIndex) Write one reference to the reftable.

Method parameters in org.eclipse.jgit.internal.storage.reftable with type arguments of type Ref

Modifier and Type	Method and Description
static Reftable	Reftable.from(Collection<Ref> refs) References to convert into a reftable
ReftableWriter	ReftableWriter.sortAndWriteRefs(Collection<Ref> refsToPack) Sort a collection of references and write them to the reftable.

Uses of Ref in org.eclipse.jgit.internal.storage.reftree

Methods in org.eclipse.jgit.internal.storage.reftree that return Ref

Modifier and Type	Method and Description
Ref	RefTree.exactRef(ObjectReader reader, String name) Read one reference.
Ref	RefTreeDatabase.exactRef(String name) Read a single reference.
Ref	Command.getNewRef() New peeled reference.
Ref	Command.getOldRef() Old peeled reference.
Ref	RefTreeDatabase.getRef(String name) Read a single reference.
Ref	RefTreeDatabase.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.

Methods in org.eclipse.jgit.internal.storage.reftree that return types with arguments of type Ref

Modifier and Type	Method and Description
List<Ref>	RefTreeDatabase.getAdditionalRefs() Get the additional reference-like entities from the repository.
Map<String,Ref>	RefTreeDatabase.getRefs(String prefix) Get a section of the reference namespace.

Methods in org.eclipse.jgit.internal.storage.reftree with parameters of type Ref

Modifier and Type	Method and Description
Ref	RefTreeDatabase.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.

Constructors in org.eclipse.jgit.internal.storage.reftree with parameters of type Ref

Constructor and Description
Command(Ref oldRef, Ref newRef) Create a command to create, update or delete a reference.

Uses of Ref in org.eclipse.jgit.lib

Classes in org.eclipse.jgit.lib that implement Ref

Modifier and Type	Class and Description
class	ObjectIdRef A Ref that points directly at an ObjectId.
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.
class	SymbolicRef A reference that indirectly points at another Ref.

Methods in org.eclipse.jgit.lib that return Ref

Modifier and Type	Method and Description
Ref	Repository.exactRef(String name) Get a ref by name.
Ref	RefDatabase.exactRef(String name) Read a single reference.
static Ref	RefDatabase.findRef(Map<String,Ref> map, String name) Try to find the specified name in the ref map using RefDatabase.SEARCH_PATH.
Ref	Repository.findRef(String name) Search for a ref by (possibly abbreviated) name.
Ref	RefDatabase.firstExactRef(String... refs) Find the first named reference.
Ref	SymbolicRef.getLeaf() Traverse target references until isSymbolic() is false.
Ref	ObjectIdRef.getLeaf() Traverse target references until isSymbolic() is false.
Ref	Ref.getLeaf() Traverse target references until isSymbolic() is false.
Ref	RefUpdate.getRef() Get the reference this update will create or modify.
abstract Ref	RefDatabase.getRef(String name) Read a single reference.
Ref	SymbolicRef.getTarget() Get the reference this reference points to, or this.
Ref	ObjectIdRef.getTarget() Get the reference this reference points to, or this.
Ref	Ref.getTarget() Get the reference this reference points to, or this.
Ref	Repository.peel(Ref ref) Deprecated. use getRefDatabase().peel(ref) instead.
abstract Ref	RefDatabase.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.

Methods in org.eclipse.jgit.lib that return types with arguments of type Ref

Modifier and Type	Method and Description
Map<String,Ref>	RefDatabase.exactRef(String... refs) Read the specified references.
abstract List<Ref>	RefDatabase.getAdditionalRefs() Get the additional reference-like entities from the repository.
Map<String,Ref>	Repository.getAllRefs() Get mutable map of all known refs, including symrefs like HEAD that may not point to any object yet.
Map<AnyObjectId,Set<Ref>>	Repository.getAllRefsByPeeledObjectId() Get a map with all objects referenced by a peeled ref.
List<Ref>	RefDatabase.getRefs() Returns all refs.
abstract Map<String,Ref>	RefDatabase.getRefs(String prefix) Deprecated. use RefDatabase.getRefsByPrefix(java.lang.String) instead
List<Ref>	RefDatabase.getRefsByPrefix(String prefix) Returns refs whose names start with a given prefix.
Map<String,Ref>	Repository.getTags() Deprecated. use getRefDatabase().getRefsByPrefix(R_TAGS) instead
static Collection<Ref>	RefComparator.sort(Collection<Ref> refs) Sorts the collection of refs, returning a new collection.

Methods in org.eclipse.jgit.lib with parameters of type Ref

Modifier and Type	Method and Description
int	RefComparator.compare(Ref o1, Ref o2)
static int	RefComparator.compareTo(Ref o1, Ref o2) Compare two references by name.
static int	RefComparator.compareTo(Ref o1, String o2) Compare a reference to a name.
Ref	Repository.peel(Ref ref) Deprecated. use getRefDatabase().peel(ref) instead.
abstract Ref	RefDatabase.peel(Ref ref) Peel a possibly unpeeled reference by traversing the annotated tags.

Method parameters in org.eclipse.jgit.lib with type arguments of type Ref

Modifier and Type	Method and Description
static Ref	RefDatabase.findRef(Map<String,Ref> map, String name) Try to find the specified name in the ref map using RefDatabase.SEARCH_PATH.
static Collection<Ref>	RefComparator.sort(Collection<Ref> refs) Sorts the collection of refs, returning a new collection.

Constructors in org.eclipse.jgit.lib with parameters of type Ref

Constructor and Description
RefUpdate(Ref ref) Construct a new update operation for the reference.
SymbolicRef(String refName, Ref target) Create a new ref pairing.

Constructor parameters in org.eclipse.jgit.lib with type arguments of type Ref

Constructor and Description
RefWriter(Collection<Ref> refs) Constructor for RefWriter.
RefWriter(Map<String,Ref> refs) Constructor for RefWriter.
RefWriter(RefList<Ref> refs) Constructor for RefWriter.

Uses of Ref in org.eclipse.jgit.merge

Methods in org.eclipse.jgit.merge with parameters of type Ref

Modifier and Type	Method and Description
String	MergeMessageFormatter.format(List<Ref> refsToMerge, Ref target) Construct the merge commit message.
String	SquashMessageFormatter.format(List<RevCommit> squashedCommits, Ref target) Construct the squashed commit message.

Method parameters in org.eclipse.jgit.merge with type arguments of type Ref

Modifier and Type	Method and Description
String	MergeMessageFormatter.format(List<Ref> refsToMerge, Ref target) Construct the merge commit message.

Uses of Ref in org.eclipse.jgit.revplot

Methods in org.eclipse.jgit.revplot that return Ref

Modifier and Type	Method and Description
Ref	PlotCommit.getRef(int nth) Get the nth Ref from this commit's ref list.

Methods in org.eclipse.jgit.revplot with parameters of type Ref

Modifier and Type	Method and Description
protected abstract int	AbstractPlotRenderer.drawLabel(int x, int y, Ref ref) Draw a decoration for the Ref ref at x,y

Method parameters in org.eclipse.jgit.revplot with type arguments of type Ref

Modifier and Type	Method and Description
void	PlotWalk.addAdditionalRefs(Iterable<Ref> refs) Add additional refs to the walk

Uses of Ref in org.eclipse.jgit.revwalk

Methods in org.eclipse.jgit.revwalk that return types with arguments of type Ref

Modifier and Type	Method and Description
static List<Ref>	RevWalkUtils.findBranchesReachableFrom(RevCommit commit, RevWalk revWalk, Collection<Ref> refs) Find the list of branches a given commit is reachable from when following parent.s

Method parameters in org.eclipse.jgit.revwalk with type arguments of type Ref

Modifier and Type	Method and Description
static List<Ref>	RevWalkUtils.findBranchesReachableFrom(RevCommit commit, RevWalk revWalk, Collection<Ref> refs) Find the list of branches a given commit is reachable from when following parent.s

Uses of Ref in org.eclipse.jgit.transport

Methods in org.eclipse.jgit.transport that return Ref

Modifier and Type	Method and Description
Ref	OperationResult.getAdvertisedRef(String name) Get a single advertised ref by name.
Ref	ReceiveCommand.getRef() Get the ref, if this was advertised by the connection.
Ref	BaseConnection.getRef(String name) Get a single advertised ref by name.
Ref	Connection.getRef(String name) Get a single advertised ref by name.

Methods in org.eclipse.jgit.transport that return types with arguments of type Ref

Modifier and Type	Method and Description
Map<String,Ref>	RefFilter.filter(Map<String,Ref> refs) Filters a Map of refs before it is advertised to the client.
protected Map<String,Ref>	BaseReceivePack.getAdvertisedOrDefaultRefs() Get advertised refs, or the default if not explicitly advertised.
Map<String,Ref>	BaseReceivePack.getAdvertisedRefs() Get refs which were advertised to the client.
Map<String,Ref>	UploadPack.getAdvertisedRefs() Get refs which were advertised to the client.
Collection<Ref>	OperationResult.getAdvertisedRefs() Get the complete list of refs advertised by the remote.
protected abstract Map<String,Ref>	AbstractAdvertiseRefsHook.getAdvertisedRefs(Repository repository, RevWalk revWalk) Get the refs to advertise.
Collection<Ref>	BaseConnection.getRefs() Get the complete list of refs advertised as available for fetching or pushing.
Collection<Ref>	Connection.getRefs() Get the complete list of refs advertised as available for fetching or pushing.
Map<String,Ref>	BaseConnection.getRefsMap() Get the complete map of refs advertised as available for fetching or pushing.
Map<String,Ref>	Connection.getRefsMap() Get the complete map of refs advertised as available for fetching or pushing.

Methods in org.eclipse.jgit.transport with parameters of type Ref

Modifier and Type	Method and Description
RefSpec	RefSpec.expandFromDestination(Ref r) Expand this specification to exactly match a ref.
RefSpec	RefSpec.expandFromSource(Ref r) Expand this specification to exactly match a ref.
void	BundleWriter.include(Ref r) Include a single ref (a name/object pair) in the bundle.
boolean	RefSpec.matchDestination(Ref r) Does this specification's destination description match the ref?
boolean	RefSpec.matchSource(Ref r) Does this specification's source description match the ref?

Method parameters in org.eclipse.jgit.transport with type arguments of type Ref

Modifier and Type	Method and Description
protected void	BaseConnection.available(Map<String,Ref> all) Denote the list of refs available on the remote repository.
protected void	BasePackFetchConnection.doFetch(ProgressMonitor monitor, Collection<Ref> want, Set<ObjectId> have, OutputStream outputStream) Execute common ancestor negotiation and fetch the objects.
void	BasePackFetchConnection.fetch(ProgressMonitor monitor, Collection<Ref> want, Set<ObjectId> have) Fetch objects we don't have but that are reachable from advertised refs.
void	FetchConnection.fetch(ProgressMonitor monitor, Collection<Ref> want, Set<ObjectId> have) Fetch objects we don't have but that are reachable from advertised refs.
void	BasePackFetchConnection.fetch(ProgressMonitor monitor, Collection<Ref> want, Set<ObjectId> have, OutputStream outputStream) Fetch objects we don't have but that are reachable from advertised refs.
void	FetchConnection.fetch(ProgressMonitor monitor, Collection<Ref> want, Set<ObjectId> have, OutputStream out) Fetch objects we don't have but that are reachable from advertised refs.
Map<String,Ref>	RefFilter.filter(Map<String,Ref> refs) Filters a Map of refs before it is advertised to the client.
Set<ObjectId>	RefAdvertiser.send(Collection<Ref> refs) Format an advertisement for the supplied refs.
Set<ObjectId>	RefAdvertiser.send(Map<String,Ref> refs) Deprecated. use RefAdvertiser.send(Collection) instead.
void	UploadPack.setAdvertisedRefs(Map<String,Ref> allRefs) Set the refs advertised by this UploadPack.
void	BaseReceivePack.setAdvertisedRefs(Map<String,Ref> allRefs, Set<ObjectId> additionalHaves) Set the refs advertised by this ReceivePack.

Constructors in org.eclipse.jgit.transport with parameters of type Ref

Constructor and Description
RemoteRefUpdate(Repository localDb, Ref srcRef, String remoteName, boolean forceUpdate, String localName, ObjectId expectedOldObjectId) Construct remote ref update request by providing an update specification.

Uses of Ref in org.eclipse.jgit.util

Classes in org.eclipse.jgit.util with type parameters of type Ref

Modifier and Type	Class and Description
class	RefList<T extends Ref> Specialized variant of an ArrayList to support a RefDatabase.
static class	RefList.Builder<T extends Ref> Builder to facilitate fast construction of an immutable RefList.

Methods in org.eclipse.jgit.util with type parameters of type Ref

Modifier and Type	Method and Description
static <T extends Ref> RefList<T>	RefList.emptyList() Create an empty unmodifiable reference list.

Methods in org.eclipse.jgit.util that return Ref

Modifier and Type	Method and Description
Ref	RefMap.get(Object key)
Ref	RefMap.put(String keyName, Ref value)
Ref	RefMap.remove(Object key)

Methods in org.eclipse.jgit.util that return types with arguments of type Ref

Modifier and Type	Method and Description
List<Ref>	RefList.asList() Cast this as an immutable, standard List.
Set<Map.Entry<String,Ref>>	RefMap.entrySet()
Iterator<Ref>	RefList.iterator()

Methods in org.eclipse.jgit.util with parameters of type Ref

Modifier and Type	Method and Description
void	RefList.Builder.addAll(Ref[] src, int off, int cnt) Add all items from a source array.
Ref	RefMap.put(String keyName, Ref value)

Constructor parameters in org.eclipse.jgit.util with type arguments of type Ref

Constructor and Description
RefMap(String prefix, RefList<? extends Ref> packed, RefList<? extends Ref> loose, RefList<? extends Ref> resolved) Construct a map to merge 3 collections together.
RefMap(String prefix, RefList<? extends Ref> packed, RefList<? extends Ref> loose, RefList<? extends Ref> resolved) Construct a map to merge 3 collections together.
RefMap(String prefix, RefList<? extends Ref> packed, RefList<? extends Ref> loose, RefList<? extends Ref> resolved) Construct a map to merge 3 collections together.