org.eclipse.jgit.internal.storage.reftable

Class LogCursor

java.lang.Object

org.eclipse.jgit.internal.storage.reftable.LogCursor

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EmptyLogCursor, MergedReftable.MergedLogCursor, ReftableReader.LogCursorImpl

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

Iterator over logs inside a Reftable.

Constructor Summary

Constructors

Constructor and Description
LogCursor()

Method Summary

Modifier and Type	Method and Description
abstract void	close()
abstract ReflogEntry	getReflogEntry() Get current log entry.
abstract java.lang.String	getRefName() Get name of the current reference.
abstract long	getUpdateIndex() Get identifier of the transaction that created the log record.
abstract boolean	next() Check if another log record is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogCursor

public LogCursor()

Method Detail

next

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

Check if another log record is available.

Returns:

true if there is another result.

Throws:

java.io.IOException - logs cannot be read.

getRefName

public abstract java.lang.String getRefName()

Get name of the current reference.

Returns:

name of the current reference.

getUpdateIndex

public abstract long getUpdateIndex()

Get identifier of the transaction that created the log record.

Returns:

identifier of the transaction that created the log record.

getReflogEntry

public abstract ReflogEntry getReflogEntry()

Get current log entry.

Returns:

current log entry.

close

public abstract void close()

Specified by:

close in interface java.lang.AutoCloseable