Class RefCursor
- java.lang.Object
-
- org.eclipse.jgit.internal.storage.reftable.RefCursor
-
- All Implemented Interfaces:
AutoCloseable
public abstract class RefCursor extends Object implements AutoCloseable
Iterator over references inside aReftable
.
-
-
Constructor Summary
Constructors Constructor Description RefCursor()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
close()
abstract Ref
getRef()
Get reference at the current position.abstract boolean
next()
Check if another reference is available.abstract void
seekPastPrefix(String prefixName)
Seeks forward to the first ref record lexicographically beyondprefixName
that doesn't start withprefixName
.boolean
wasDeleted()
Whether the current reference was deleted.
-
-
-
Method Detail
-
next
public abstract boolean next() throws IOException
Check if another reference is available.- Returns:
true
if there is another result.- Throws:
IOException
- references cannot be read.
-
seekPastPrefix
public abstract void seekPastPrefix(String prefixName) throws IOException
Seeks forward to the first ref record lexicographically beyondprefixName
that doesn't start withprefixName
. If there are no more results, skipping some refs won't add new results. E.g if we create a RefCursor that returns only results with a specific prefix, skipping that prefix won't give results that are not part of the original prefix.- Parameters:
prefixName
- prefix that should be skipped. All previous refs before it will be skipped.- Throws:
IOException
- references cannot be read.
-
getRef
public abstract Ref getRef()
Get reference at the current position.- Returns:
- reference at the current position.
-
wasDeleted
public boolean wasDeleted()
Whether the current reference was deleted.- Returns:
true
if the current reference was deleted.
-
close
public abstract void close()
- Specified by:
close
in interfaceAutoCloseable
-
-