java.lang.Object
org.eclipse.jgit.internal.storage.reftable.Reftable
org.eclipse.jgit.internal.storage.reftable.ReftableReader
- All Implemented Interfaces:
AutoCloseable
Reads a reftable formatted file.
ReftableReader
is not thread-safe. Concurrent readers need their own
instance to read from the same file.
-
Field Summary
Fields inherited from class org.eclipse.jgit.internal.storage.reftable.Reftable
includeDeletes
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallLogs()
Seek reader to read log records.allRefs()
Seek to the first reference, to iterate in order.int
Get the block size in bytes chosen for this file by the writer.Match references pointing to a specific object.void
close()
boolean
Whether this reftable can do a fast SHA1 => ref lookuplong
Get the maximum update index for ref entries that appear in this reftable.long
Get the minimum update index for ref entries that appear in this reftable.Seek to an update index in a reference's log.Seek to a reference.seekRefsWithPrefix
(String prefix) Seek references with prefix.long
size()
Get size of the reftable, in bytes.Methods inherited from class org.eclipse.jgit.internal.storage.reftable.Reftable
exactRef, from, hasId, hasRef, hasRefsWithPrefix, resolve, seekLog, setIncludeDeletes
-
Constructor Details
-
ReftableReader
Initialize a new reftable reader.- Parameters:
src
- the file content to read.
-
-
Method Details
-
blockSize
Get the block size in bytes chosen for this file by the writer.- Returns:
- the block size in bytes chosen for this file by the writer. Most
reads from the
BlockSource
will be aligned to the block size. - Throws:
IOException
- file cannot be read.
-
hasObjectMap
Description copied from class:Reftable
Whether this reftable can do a fast SHA1 => ref lookup- Specified by:
hasObjectMap
in classReftable
- Returns:
- whether this reftable can do a fast SHA1 => ref lookup.
- Throws:
IOException
- on I/O problems.
-
minUpdateIndex
Get the minimum update index for ref entries that appear in this reftable.- Specified by:
minUpdateIndex
in classReftable
- Returns:
- the minimum update index for ref entries that appear in this reftable.
- Throws:
IOException
- file cannot be read.
-
maxUpdateIndex
Get the maximum update index for ref entries that appear in this reftable.- Specified by:
maxUpdateIndex
in classReftable
- Returns:
- the maximum update index for ref entries that appear in this reftable.
- Throws:
IOException
- file cannot be read.
-
allRefs
Description copied from class:Reftable
Seek to the first reference, to iterate in order.- Specified by:
allRefs
in classReftable
- Returns:
- cursor to iterate.
- Throws:
IOException
- if references cannot be read.
-
seekRef
Description copied from class:Reftable
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.- Specified by:
seekRef
in classReftable
- Parameters:
refName
- reference name.- Returns:
- cursor to iterate; empty cursor if no references match.
- Throws:
IOException
- if references cannot be read.
-
seekRefsWithPrefix
Description copied from class:Reftable
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.- Specified by:
seekRefsWithPrefix
in classReftable
- Parameters:
prefix
- prefix to find.- Returns:
- cursor to iterate; empty cursor if no references match.
- Throws:
IOException
- if references cannot be read.
-
byObjectId
Description copied from class:Reftable
Match references pointing to a specific object.- Specified by:
byObjectId
in classReftable
- Parameters:
id
- object to find.- Returns:
- cursor to iterate; empty cursor if no references match.
- Throws:
IOException
- if references cannot be read.
-
allLogs
Description copied from class:Reftable
Seek reader to read log records.- Specified by:
allLogs
in classReftable
- Returns:
- cursor to iterate; empty cursor if no logs are present.
- Throws:
IOException
- if logs cannot be read.
-
seekLog
Description copied from class:Reftable
Seek to an update index in a reference's log.- Specified by:
seekLog
in classReftable
- Parameters:
refName
- exact name of the reference whose log to read.updateIndex
- most recent index to return first in the log cursor. Log records at or beforeupdateIndex
will be returned.- Returns:
- cursor to iterate; empty cursor if no logs match.
- Throws:
IOException
- if logs cannot be read.
-
size
Get size of the reftable, in bytes.- Returns:
- size of the reftable, in bytes.
- Throws:
IOException
- size cannot be obtained.
-
close
- Specified by:
close
in interfaceAutoCloseable
- Throws:
IOException
-