org.eclipse.jgit.internal.storage.reftable

Class RefCursor

java.lang.Object

org.eclipse.jgit.internal.storage.reftable.RefCursor

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

MergedReftable.MergedRefCursor, ReftableReader.ObjCursorImpl, ReftableReader.RefCursorImpl

public abstract class RefCursor
extends java.lang.Object
implements java.lang.AutoCloseable

Iterator over references inside a Reftable.

Constructor Summary

Constructors

Constructor and Description
RefCursor()

Method Summary

Modifier and Type	Method and Description
abstract void	close()
abstract Ref	getRef() Get reference at the current position.
abstract long	getUpdateIndex() Get updateIndex that last modified the current reference.
abstract boolean	next() Check if another reference is available.
boolean	wasDeleted() Whether the current reference was deleted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RefCursor

public RefCursor()

Method Detail

next

public abstract boolean next()
                      throws java.io.IOException

Check if another reference is available.

Returns:

true if there is another result.

Throws:

java.io.IOException - references cannot be read.

getRef

public abstract Ref getRef()

Get reference at the current position.

Returns:

reference at the current position.

getUpdateIndex

public abstract long getUpdateIndex()

Get updateIndex that last modified the current reference.

Returns:

updateIndex that last modified the current reference.

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 interface java.lang.AutoCloseable