public Class ReftableReader

public ReftableReader(BlockSource src)

Initialize a new reftable reader.

Parameters

src:BlockSource: the file content to read.

Method Detail

allLogs	back to summary
public LogCursor allLogs() throws IOException Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.allLogs. Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.allLogs. Seek reader to read log records. Returns:LogCursor cursor to iterate; empty cursor if no logs are present. Annotations @Override Exceptions IOException: if logs cannot be read.

allLogs

public LogCursor allLogs() throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.allLogs.

Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.allLogs.

Seek reader to read log records.

Returns:LogCursor

cursor to iterate; empty cursor if no logs are present.

Annotations

@Override

Exceptions

IOException:: if logs cannot be read.

allRefs	back to summary
public RefCursor allRefs() throws IOException Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.allRefs. Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.allRefs. Seek to the first reference, to iterate in order. Returns:RefCursor cursor to iterate. Annotations @Override Exceptions IOException: if references cannot be read.

allRefs

public RefCursor allRefs() throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.allRefs.

Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.allRefs.

Seek to the first reference, to iterate in order.

Returns:RefCursor

cursor to iterate.

Annotations

@Override

Exceptions

IOException:: if references cannot be read.

binarySearch	back to summary
private BlockReader binarySearch(byte blockType, byte[] key, long startPos, long endPos) throws IOException

blocksIn	back to summary
private int blocksIn(long pos, long end)

blockSize back to summary

blockSize	back to summary
public int blockSize() throws IOException Get the block size in bytes chosen for this file by the writer. Returns:int the block size in bytes chosen for this file by the writer. Most reads from the `org.eclipse.jgit.internal.storage.io.BlockSource` will be aligned to the block size. Exceptions IOException: file cannot be read.

public int blockSize() throws IOException

Get the block size in bytes chosen for this file by the writer.

Returns:int

the block size in bytes chosen for this file by the writer. Most reads from the org.eclipse.jgit.internal.storage.io.BlockSource will be aligned to the block size.

Exceptions

IOException:: file cannot be read.

byObjectId	back to summary
public RefCursor byObjectId(AnyObjectId id) throws IOException Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.byObjectId. Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.byObjectId. Match references pointing to a specific object. Parameters id:AnyObjectId object to find. Returns:RefCursor cursor to iterate; empty cursor if no references match. Annotations @Override Exceptions IOException: if references cannot be read.

byObjectId

public RefCursor byObjectId(AnyObjectId id) throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.byObjectId.

Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.byObjectId.

Match references pointing to a specific object.

Parameters

id:AnyObjectId: object to find.

Returns:RefCursor

cursor to iterate; empty cursor if no references match.

Annotations

@Override

Exceptions

IOException:: if references cannot be read.

close back to summary

close	back to summary
public void close() throws IOException Implements java.lang.AutoCloseable.close. Doc from java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Annotations @Override

public void close() throws IOException

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

hasObjectMap	back to summary
public boolean hasObjectMap() throws IOException Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.hasObjectMap. Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.hasObjectMap. Whether this reftable can do a fast SHA1 => ref lookup Returns:boolean whether this reftable can do a fast SHA1 => ref lookup. Annotations @Override Exceptions IOException: on I/O problems.

hasObjectMap

public boolean hasObjectMap() throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.hasObjectMap.

Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.hasObjectMap.

Whether this reftable can do a fast SHA1 => ref lookup

Returns:boolean

whether this reftable can do a fast SHA1 => ref lookup.

Annotations

@Override

Exceptions

IOException:: on I/O problems.

initLogIndex	back to summary
private void initLogIndex() throws IOException

initObjIndex	back to summary
private void initObjIndex() throws IOException

initRefIndex	back to summary
private void initRefIndex() throws IOException

maxUpdateIndex	back to summary
public long maxUpdateIndex() throws IOException Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.maxUpdateIndex. Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.maxUpdateIndex. Get the maximum update index for ref entries that appear in this reftable. Returns:long the maximum update index for ref entries that appear in this reftable. Annotations @Override Exceptions IOException: file cannot be read.

maxUpdateIndex

public long maxUpdateIndex() throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.maxUpdateIndex.

Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.maxUpdateIndex.

Get the maximum update index for ref entries that appear in this reftable.

Returns:long

the maximum update index for ref entries that appear in this reftable.

Annotations

@Override

Exceptions

IOException:: file cannot be read.

minUpdateIndex	back to summary
public long minUpdateIndex() throws IOException Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.minUpdateIndex. Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.minUpdateIndex. Get the minimum update index for ref entries that appear in this reftable. Returns:long the minimum update index for ref entries that appear in this reftable. Annotations @Override Exceptions IOException: file cannot be read.

minUpdateIndex

public long minUpdateIndex() throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.minUpdateIndex.

Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.minUpdateIndex.

Get the minimum update index for ref entries that appear in this reftable.

Returns:long

the minimum update index for ref entries that appear in this reftable.

Annotations

@Override

Exceptions

IOException:: file cannot be read.

readBlock	back to summary
private BlockReader readBlock(long pos, long end) throws IOException

readBlockLen	back to summary
private int readBlockLen(long pos) throws IOException

readFileFooter	back to summary
private void readFileFooter() throws IOException

readFileHeader	back to summary
private void readFileHeader() throws IOException

readHeaderOrFooter	back to summary
private byte[] readHeaderOrFooter(long pos, int len) throws IOException

readIndex	back to summary
private BlockReader readIndex(long pos) throws IOException

seek	back to summary
private BlockReader seek(byte blockType, byte[] key, BlockReader idx, long startPos, long endPos) throws IOException

seekLog back to summary

seekLog	back to summary
public LogCursor seekLog(String refName, long updateIndex) throws IOException Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.seekLog. Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.seekLog. Seek to an update index in a reference's log. Parameters refName:String exact name of the reference whose log to read. updateIndex:long most recent index to return first in the log cursor. Log records at or before `updateIndex` will be returned. Returns:LogCursor cursor to iterate; empty cursor if no logs match. Annotations @Override Exceptions IOException: if logs cannot be read.

public LogCursor seekLog(String refName, long updateIndex) throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.seekLog.

Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.seekLog.

Seek to an update index in a reference's log.

Parameters

refName:String: exact name of the reference whose log to read.
updateIndex:long: most recent index to return first in the log cursor. Log records at or before updateIndex will be returned.

Returns:LogCursor

cursor to iterate; empty cursor if no logs match.

Annotations

@Override

Exceptions

IOException:: if logs cannot be read.

seekRef back to summary

seekRef	back to summary
public RefCursor seekRef(String refName) throws IOException Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.seekRef. Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.seekRef. Seek to a reference. This method will seek to the reference `refName`. If present, the returned cursor will iterate exactly one entry. If not found, an empty cursor is returned. Parameters refName:String reference name. Returns:RefCursor cursor to iterate; empty cursor if no references match. Annotations @Override Exceptions IOException: if references cannot be read.

public RefCursor seekRef(String refName) throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.seekRef.

Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.seekRef.

Seek to a reference.

This method will seek to the reference refName. If present, the returned cursor will iterate exactly one entry. If not found, an empty cursor is returned.

Parameters

refName:String: reference name.

Returns:RefCursor

cursor to iterate; empty cursor if no references match.

Annotations

@Override

Exceptions

IOException:: if references cannot be read.

seekRefsWithPrefix back to summary

seekRefsWithPrefix	back to summary
public RefCursor seekRefsWithPrefix(String prefix) throws IOException Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.seekRefsWithPrefix. Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.seekRefsWithPrefix. Seek references with prefix. The method will seek all the references starting with `prefix` as a prefix. If no references start with this prefix, an empty cursor is returned. Parameters prefix:String prefix to find. Returns:RefCursor cursor to iterate; empty cursor if no references match. Annotations @Override Exceptions IOException: if references cannot be read.

public RefCursor seekRefsWithPrefix(String prefix) throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.Reftable.seekRefsWithPrefix.

Doc from org.eclipse.jgit.internal.storage.reftable.Reftable.seekRefsWithPrefix.

Seek references with prefix.

The method will seek all the references starting with prefix as a prefix. If no references start with this prefix, an empty cursor is returned.

Parameters

prefix:String: prefix to find.

Returns:RefCursor

cursor to iterate; empty cursor if no references match.

Annotations

@Override

Exceptions

IOException:: if references cannot be read.

size	back to summary
public long size() throws IOException Get size of the reftable, in bytes. Returns:long size of the reftable, in bytes. Exceptions IOException: size cannot be obtained.

size

public long size() throws IOException

Get size of the reftable, in bytes.

Returns:long

size of the reftable, in bytes.

Exceptions

IOException:: size cannot be obtained.

org.eclipse.jgit.internal.storage.reftable back to summary

private Class ReftableReader.LogCursorImpl

Class Inheritance

extends LogCursor

java.lang.Object
org.eclipse.jgit.internal.storage.reftable.LogCursor
org.eclipse.jgit.internal.storage.reftable.ReftableReader.LogCursorImpl

Field Summary

Modifier and Type	Field and Description
pack-priv BlockReader	block
private ReflogEntry	entry
private final byte[]	match
private String	refName
private final long	scanEnd
private long	updateIndex

Constructor Summary

Access	Constructor and Description
pack-priv	LogCursorImpl(long end of the log data in the reftable. scanEnd, byte[] if non-null, limits the scan to precisely that refname. match) Scans logs from this table until scanEnd position.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.close. Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
public ReflogEntry	getReflogEntry() Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.getReflogEntry. Get current log entry.
public String	getRefName() Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.getRefName. Get name of the current reference.
public long	getUpdateIndex() Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.getUpdateIndex. Get identifier of the transaction that created the log record.
public boolean	next() Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.next. Check if another log record is available.

Field Detail

block	back to summary
pack-priv BlockReader block

entry	back to summary
private ReflogEntry entry

match	back to summary
private final byte[] match

refName	back to summary
private String refName

scanEnd	back to summary
private final long scanEnd

updateIndex	back to summary
private long updateIndex

Constructor Detail

LogCursorImpl

pack-priv LogCursorImpl(long scanEnd, byte[] match)

Scans logs from this table until scanEnd position.

Parameters

scanEnd:long: end of the log data in the reftable.
match:byte[]: if non-null, limits the scan to precisely that refname.

Method Detail

close back to summary

public void close()

Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

getReflogEntry

public ReflogEntry getReflogEntry()

Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.getReflogEntry.

Doc from org.eclipse.jgit.internal.storage.reftable.LogCursor.getReflogEntry.

Get current log entry.

Returns:ReflogEntry

current log entry. Maybe null if we are producing deletions.

Annotations

@Override

getRefName

public String getRefName()

Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.getRefName.

Doc from org.eclipse.jgit.internal.storage.reftable.LogCursor.getRefName.

Get name of the current reference.

Returns:String

name of the current reference.

Annotations

@Override

getUpdateIndex

public long getUpdateIndex()

Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.getUpdateIndex.

Doc from org.eclipse.jgit.internal.storage.reftable.LogCursor.getUpdateIndex.

Get identifier of the transaction that created the log record.

Returns:long

identifier of the transaction that created the log record.

Annotations

@Override

next back to summary

public boolean next() throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.LogCursor.next.

Doc from org.eclipse.jgit.internal.storage.reftable.LogCursor.next.

Check if another log record is available.

Returns:boolean

true if there is another result.

Annotations

@Override

Exceptions

IOException:: logs cannot be read.

org.eclipse.jgit.internal.storage.reftable back to summary

private Class ReftableReader.ObjCursorImpl

Class Inheritance

extends RefCursor

java.lang.Object
org.eclipse.jgit.internal.storage.reftable.RefCursor
org.eclipse.jgit.internal.storage.reftable.ReftableReader.ObjCursorImpl

Field Summary

Modifier and Type	Field and Description
private BlockReader	block
private LongList	blockPos
private int	listIdx
private final ObjectId	match
private Ref	ref
private final long	scanEnd

Constructor Summary

Access	Constructor and Description
pack-priv	ObjCursorImpl(long scanEnd, AnyObjectId id)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.close. Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
public Ref	getRef() Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.getRef. Get reference at the current position.
pack-priv void	initScan()
pack-priv void	initSeek()
public boolean	next() Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.next. Check if another reference is available.
public void	seekPastPrefix(String prefix that should be skipped. All previous refs before it will be skipped. prefixName) Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.seekPastPrefix. Seeks forward to the first ref record lexicographically beyond `prefixName` that doesn't start with `prefixName`.

Inherited from org.eclipse.jgit.internal.storage.reftable.RefCursor:: wasDeleted

Field Detail

block	back to summary
private BlockReader block

blockPos	back to summary
private LongList blockPos

listIdx	back to summary
private int listIdx

match	back to summary
private final ObjectId match

ref	back to summary
private Ref ref

scanEnd	back to summary
private final long scanEnd

Constructor Detail

ObjCursorImpl	back to summary
pack-priv ObjCursorImpl(long scanEnd, AnyObjectId id)

Method Detail

close back to summary

public void close()

Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

getRef

public Ref getRef()

Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.getRef.

Doc from org.eclipse.jgit.internal.storage.reftable.RefCursor.getRef.

Get reference at the current position.

Returns:Ref

reference at the current position.

Annotations

@Override

initScan	back to summary
pack-priv void initScan() throws IOException

initSeek	back to summary
pack-priv void initSeek() throws IOException

next back to summary

public boolean next() throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.next.

Doc from org.eclipse.jgit.internal.storage.reftable.RefCursor.next.

Check if another reference is available.

Returns:boolean

true if there is another result.

Annotations

@Override

Exceptions

IOException:: references cannot be read.

seekPastPrefix back to summary

public void seekPastPrefix(String prefixName) throws IOException

Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.seekPastPrefix.

Doc from org.eclipse.jgit.internal.storage.reftable.RefCursor.seekPastPrefix.

Seeks forward to the first ref record lexicographically beyond prefixName that doesn't start with prefixName. 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:String: prefix that should be skipped. All previous refs before it will be skipped.

Annotations

@Override

Exceptions

IOException:: references cannot be read.

org.eclipse.jgit.internal.storage.reftable back to summary

private Class ReftableReader.RefCursorImpl

Class Inheritance

extends RefCursor

java.lang.Object
org.eclipse.jgit.internal.storage.reftable.RefCursor
org.eclipse.jgit.internal.storage.reftable.ReftableReader.RefCursorImpl

Field Summary

Modifier and Type	Field and Description
pack-priv BlockReader	block
private final byte[]	match
private final boolean	prefix
private Ref	ref
private final long	scanEnd

Constructor Summary

Access	Constructor and Description
pack-priv	RefCursorImpl(long scanEnd, byte[] match, boolean prefix)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.close. Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
public Ref	getRef() Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.getRef. Get reference at the current position.
public boolean	next() Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.next. Check if another reference is available.
public void	seekPastPrefix(String prefix that should be skipped. All previous refs before it will be skipped. prefixName) Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.seekPastPrefix. Seeks forward to the first ref record lexicographically beyond `prefixName` that doesn't start with `prefixName`.

Inherited from org.eclipse.jgit.internal.storage.reftable.RefCursor:: wasDeleted

Field Detail

block	back to summary
pack-priv BlockReader block

match	back to summary
private final byte[] match

prefix	back to summary
private final boolean prefix

ref	back to summary
private Ref ref

scanEnd	back to summary
private final long scanEnd

Constructor Detail

RefCursorImpl	back to summary
pack-priv RefCursorImpl(long scanEnd, byte[] match, boolean prefix)

Method Detail

close back to summary

public void close()

Implements abstract org.eclipse.jgit.internal.storage.reftable.RefCursor.close.