## 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.storage.dfs | Distributed file system based repository storage.
org.eclipse.jgit.internal.storage.file | File based repository storage.
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` | TagCommand.`call()` Executes the `tag` command with all the options and parameters collected by the setter methods of this class.
`Ref` | CreateBranchCommand.`call()`
`Ref` | ResetCommand.`call()` Executes the `Reset` command.
`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
--- | ---
`Collection<Ref>` | LsRemoteCommand.`call()` Executes the `LsRemote` command with all the options and parameters collected by the setter methods (e.g.
`List<Ref>` | ListTagCommand.`call()`
`List<Ref>` | ListBranchCommand.`call()`
`List<Ref>` | CherryPickResult.`getCherryPickedRefs()`
`List<Ref>` | RevertCommand.`getRevertedRefs()`

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.
`MergeCommand` | MergeCommand.`include(Ref commit)`
`RevertCommand` | RevertCommand.`include(Ref commit)`
`CherryPickCommand` | CherryPickCommand.`include(Ref commit)`

Constructor parameters in org.eclipse.jgit.api with type arguments of type Ref
Constructor and Description
`CherryPickResult(RevCommit newHead, List<Ref> cherryPickedRefs)`

### 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()`

Constructors in org.eclipse.jgit.api.errors with parameters of type Ref
Constructor and Description
`ConcurrentRefUpdateException(String message, Ref ref, RefUpdate.Result rc)`
`ConcurrentRefUpdateException(String message, Ref ref, RefUpdate.Result rc, Throwable cause)`

### 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` | DfsRefDatabase.RefCache.`get(String name)` Find a reference by name.
`Ref` | DfsRefDatabase.`getRef(String needle)`
`Ref` | DfsRefDatabase.`peel(Ref ref)`

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()`
`Map<String,Ref>` | DfsRefDatabase.`getRefs(String prefix)`

Methods in org.eclipse.jgit.internal.storage.dfs with parameters of type Ref
Modifier and Type | Method and Description
--- | ---
`protected void` | DfsRefDatabase.`cachePeeledState(Ref oldLeaf, Ref newLeaf)` Update the cached peeled state of a reference
`protected abstract boolean` | DfsRefDatabase.`compareAndPut(Ref oldRef, Ref newRef)` Compare a reference, and put if it matches.
`protected abstract boolean` | DfsRefDatabase.`compareAndRemove(Ref oldRef)` Compare a reference, and delete if it matches.
`Ref` | DfsRefDatabase.`peel(Ref ref)`
`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
`DfsRefDatabase.RefCache(RefList<Ref> ids, RefList<Ref> sym)` Initialize a new reference cache.
`DfsRefDatabase.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.`getRef(String needle)`
`Ref` | RefDirectory.`peel(Ref ref)`

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()`
`Map<String,Ref>` | RefDirectory.`getRefs(String prefix)`

Methods in org.eclipse.jgit.internal.storage.file with parameters of type Ref
Modifier and Type | Method and Description
--- | ---
`Ref` | RefDirectory.`peel(Ref ref)`

### 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` | SymbolicRef.`getLeaf()`
`Ref` | ObjectIdRef.`getLeaf()`
`Ref` | Ref.`getLeaf()` Traverse target references until `isSymbolic()` is false.
`Ref` | RefUpdate.`getRef()`
`abstract Ref` | RefDatabase.`getRef(String name)` Read a single reference.
`Ref` | Repository.`getRef(String name)` Get a ref by name.
`Ref` | SymbolicRef.`getTarget()`
`Ref` | ObjectIdRef.`getTarget()`
`Ref` | Ref.`getTarget()` Get the reference this reference points to, or `this`.
`abstract Ref` | RefDatabase.`peel(Ref ref)` Peel a possibly unpeeled reference by traversing the annotated tags.
`Ref` | Repository.`peel(Ref ref)` Peel a possibly unpeeled reference to an annotated tag.

Methods in org.eclipse.jgit.lib that return types with arguments of type Ref
Modifier and Type | Method and Description
--- | ---
`abstract List<Ref>` | RefDatabase.`getAdditionalRefs()` Get the additional reference-like entities from the repository.
`Map<String,Ref>` | Repository.`getAllRefs()`
`Map<AnyObjectId,Set<Ref>>` | Repository.`getAllRefsByPeeledObjectId()`
`abstract Map<String,Ref>` | RefDatabase.`getRefs(String prefix)` Get a section of the reference namespace.
`Map<String,Ref>` | Repository.`getTags()`
`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.
`abstract Ref` | RefDatabase.`peel(Ref ref)` Peel a possibly unpeeled reference by traversing the annotated tags.
`Ref` | Repository.`peel(Ref ref)` Peel a possibly unpeeled reference to an annotated tag.

Method parameters in org.eclipse.jgit.lib with type arguments of type Ref
Modifier and Type | Method and Description
--- | ---
`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)`
`RefWriter(Map<String,Ref> refs)`
`RefWriter(RefList<Ref> refs)`

### 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()`
`Ref` | Connection.`getRef(String name)` Get a single advertised ref by name.
`Ref` | BaseConnection.`getRef(String 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()`
`Collection<Ref>` | OperationResult.`getAdvertisedRefs()` Get the complete list of refs advertised by the remote.
`Map<String,Ref>` | UploadPack.`getAdvertisedRefs()` Get refs which were advertised to the client.
`Map<String,Ref>` | BaseReceivePack.`getAdvertisedRefs()` Get refs which were advertised to the client.
`protected abstract Map<String,Ref>` | AbstractAdvertiseRefsHook.`getAdvertisedRefs(Repository repository, RevWalk revWalk)` Get the refs to advertise.
`Collection<Ref>` | Connection.`getRefs()` Get the complete list of refs advertised as available for fetching or pushing.
`Collection<Ref>` | BaseConnection.`getRefs()`
`Map<String,Ref>` | Connection.`getRefsMap()` Get the complete map of refs advertised as available for fetching or pushing.
`Map<String,Ref>` | BaseConnection.`getRefsMap()`

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` | 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)`
`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.
`void` | BasePackFetchConnection.`fetch(ProgressMonitor monitor, Collection<Ref> want, Set<ObjectId> have, OutputStream outputStream)`
`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(Map<String,Ref> refs)` Format an advertisement for the supplied refs.
`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()`

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()`
`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.