Class WindowCursor
- All Implemented Interfaces:
AutoCloseable
,ObjectReuseAsIs
-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.jgit.lib.ObjectReader
ObjectReader.Filter
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate DeltaBaseCache
private final ObjectInserter
(package private) final FileObjectDatabase
private Inflater
(package private) final byte[]
Temporary buffer large enough for at least one raw object id.private ByteWindow
Fields inherited from class org.eclipse.jgit.lib.ObjectReader
OBJ_ANY, streamFileThreshold
-
Constructor Summary
ConstructorsConstructorDescriptionWindowCursor
(FileObjectDatabase db, ObjectDirectoryInserter createdFromInserter) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
(package private) int
Copy bytes from the window to a caller supplied buffer.void
copyObjectAsIs
(PackOutputStream out, ObjectToPack otp, boolean validate) Output a previously selected representation.(package private) void
copyPackAsIs
(Pack pack, long length, PackOutputStream out) void
copyPackAsIs
(PackOutputStream out, CachedPack pack) Append an entire pack's contents onto the output stream.An index that can be used to speed up ObjectWalks.getCachedPacksAndUpdate
(BitmapIndex.BitmapBuilder needBitmap) Obtain the available cached packs that match the bitmap and update the bitmap by removing the items that are in the CachedPack.Get theObjectInserter
from which this reader was created usinginserter.newReader()
(package private) DeltaBaseCache
long
getObjectSize
(AnyObjectId objectId, int typeHint) Get only the size of an object.Returns IDs for those commits which should be considered as shallow.boolean
has
(AnyObjectId objectId) Does the requested object exist in this database?(package private) int
Inflate a region of the pack starting atposition
.(package private) Inflater
inflater()
newObjectToPack
(AnyObjectId objectId, int type) Allocate a newPackWriter
state structure for an object.Construct a new reader from the same data.open
(AnyObjectId objectId, int typeHint) Open an object from this database.(package private) void
private void
(package private) ByteArrayWindow
Resolve an abbreviated ObjectId to its full form.void
selectObjectRepresentation
(PackWriter packer, ProgressMonitor monitor, Iterable<ObjectToPack> objects) Select the best object representation for a packer.void
writeObjects
(PackOutputStream out, List<ObjectToPack> list) Write objects to the pack stream in roughly the order given.Methods inherited from class org.eclipse.jgit.lib.ObjectReader
abbreviate, abbreviate, createObjectReachabilityChecker, createReachabilityChecker, getObjectSize, getStreamFileThreshold, has, open, open, setAvoidUnreachableObjects, setStreamFileThreshold
-
Field Details
-
tempId
final byte[] tempIdTemporary buffer large enough for at least one raw object id. -
inf
-
window
-
baseCache
-
createdFromInserter
-
db
-
-
Constructor Details
-
WindowCursor
WindowCursor(FileObjectDatabase db) -
WindowCursor
WindowCursor(FileObjectDatabase db, @Nullable ObjectDirectoryInserter createdFromInserter)
-
-
Method Details
-
getDeltaBaseCache
DeltaBaseCache getDeltaBaseCache() -
newReader
Construct a new reader from the same data.Applications can use this method to build a new reader from the same data source, but for an different thread.
- Specified by:
newReader
in classObjectReader
- Returns:
- a brand new reader, using the same data source.
-
getBitmapIndex
An index that can be used to speed up ObjectWalks.- Overrides:
getBitmapIndex
in classObjectReader
- Returns:
- the index or null if one does not exist.
- Throws:
IOException
- when the index fails to load
-
getCachedPacksAndUpdate
public Collection<CachedPack> getCachedPacksAndUpdate(BitmapIndex.BitmapBuilder needBitmap) throws IOException Obtain the available cached packs that match the bitmap and update the bitmap by removing the items that are in the CachedPack.A cached pack has known starting points and may be sent entirely as-is, with almost no effort on the sender's part.
- Specified by:
getCachedPacksAndUpdate
in interfaceObjectReuseAsIs
- Parameters:
needBitmap
- the bitmap that contains all of the objects the client wants.- Returns:
- the available cached packs.
- Throws:
IOException
- the cached packs cannot be listed from the repository. Callers may choose to ignore this and continue as-if there were no cached packs.
-
resolve
Resolve an abbreviated ObjectId to its full form. This method searches for an ObjectId that begins with the abbreviation, and returns at least some matching candidates. If the returned collection is empty, no objects start with this abbreviation. The abbreviation doesn't belong to this repository, or the repository lacks the necessary objects to complete it. If the collection contains exactly one member, the abbreviation is (currently) unique within this database. There is a reasonably high probability that the returned id is what was previously abbreviated. If the collection contains 2 or more members, the abbreviation is not unique. In this case the implementation is only required to return at least 2 candidates to signal the abbreviation has conflicts. User friendly implementations should return as many candidates as reasonably possible, as the caller may be able to disambiguate further based on context. However since databases can be very large (e.g. 10 million objects) returning 625,000 candidates for the abbreviation "0" is simply unreasonable, so implementors should draw the line at around 256 matches.- Specified by:
resolve
in classObjectReader
- Parameters:
id
- abbreviated id to resolve to a complete identity. The abbreviation must have a length of at least 2.- Returns:
- candidates that begin with the abbreviated identity.
- Throws:
IOException
- the object store cannot be read.
-
has
Does the requested object exist in this database?- Overrides:
has
in classObjectReader
- Parameters:
objectId
- identity of the object to test for existence of.- Returns:
- true if the specified object is stored in this database.
- Throws:
IOException
- the object store cannot be accessed.
-
open
public ObjectLoader open(AnyObjectId objectId, int typeHint) throws MissingObjectException, IncorrectObjectTypeException, IOException Open an object from this database.- Specified by:
open
in classObjectReader
- Parameters:
objectId
- identity of the object to open.typeHint
- hint about the type of object being requested, e.g.Constants.OBJ_BLOB
;ObjectReader.OBJ_ANY
if the object type is not known, or does not matter to the caller.- Returns:
- a
ObjectLoader
for accessing the object. - Throws:
MissingObjectException
- the object does not exist.IncorrectObjectTypeException
- typeHint was not OBJ_ANY, and the object's actual type does not match typeHint.IOException
- the object store cannot be accessed.
-
getShallowCommits
Returns IDs for those commits which should be considered as shallow.- Specified by:
getShallowCommits
in classObjectReader
- Returns:
- IDs of shallow commits
- Throws:
IOException
-
getObjectSize
public long getObjectSize(AnyObjectId objectId, int typeHint) throws MissingObjectException, IncorrectObjectTypeException, IOException Get only the size of an object.The default implementation of this method opens an ObjectLoader. Databases are encouraged to override this if a faster access method is available to them.
- Overrides:
getObjectSize
in classObjectReader
- Parameters:
objectId
- identity of the object to open.typeHint
- hint about the type of object being requested, e.g.Constants.OBJ_BLOB
;ObjectReader.OBJ_ANY
if the object type is not known, or does not matter to the caller.- Returns:
- size of object in bytes.
- Throws:
MissingObjectException
- the object does not exist.IncorrectObjectTypeException
- typeHint was not OBJ_ANY, and the object's actual type does not match typeHint.IOException
- the object store cannot be accessed.
-
newObjectToPack
Allocate a newPackWriter
state structure for an object.PackWriter
allocates these objects to keep track of the per-object state, and how to load the objects efficiently into the generated stream. Implementers may subclass this type with additional object state, such as to remember what file and offset contains the object's pack encoded data.- Specified by:
newObjectToPack
in interfaceObjectReuseAsIs
- Parameters:
objectId
- the id of the object that will be packed.type
- the Git type of the object that will be packed.- Returns:
- a new instance for this object.
-
selectObjectRepresentation
public void selectObjectRepresentation(PackWriter packer, ProgressMonitor monitor, Iterable<ObjectToPack> objects) throws IOException, MissingObjectException Select the best object representation for a packer.Implementations should iterate through all available representations of an object, and pass them in turn to the PackWriter though
PackWriter.select(ObjectToPack, StoredObjectRepresentation)
so the writer can select the most suitable representation to reuse into the output stream.If the implementation returns CachedPack from
ObjectReuseAsIs.getCachedPacksAndUpdate(BitmapBuilder)
it must consider the representation of any object that is stored in any of the offered CachedPacks. PackWriter relies on this behavior to prune duplicate objects out of the pack stream when it selects a CachedPack and the object was also reached through the thin-pack enumeration.The implementation may choose to consider multiple objects at once on concurrent threads, but must evaluate all representations of an object within the same thread.
- Specified by:
selectObjectRepresentation
in interfaceObjectReuseAsIs
- Parameters:
packer
- the packer that will write the object in the near future.monitor
- progress monitor, implementation should update the monitor once for each item in the iteration when selection is done.objects
- the objects that are being packed.- Throws:
IOException
- the repository cannot be accessed. Packing will abort.MissingObjectException
- there is no representation available for the object, as it is no longer in the repository. Packing will abort.
-
copyObjectAsIs
public void copyObjectAsIs(PackOutputStream out, ObjectToPack otp, boolean validate) throws IOException, StoredObjectRepresentationNotAvailableException Output a previously selected representation.PackWriter
invokes this method only if a representation previously given to it byselectObjectRepresentation
was chosen for reuse into the output stream. Theotp
argument is an instance created by this reader's ownnewObjectToPack
, and the representation data saved within it also originated from this reader.Implementors must write the object header before copying the raw data to the output stream. The typical implementation is like:
MyToPack mtp = (MyToPack) otp; byte[] raw; if (validate) raw = validate(mtp); // throw SORNAE here, if at all else raw = readFast(mtp); out.writeHeader(mtp, mtp.inflatedSize); out.write(raw);
- Specified by:
copyObjectAsIs
in interfaceObjectReuseAsIs
- Parameters:
out
- stream the object should be written to.otp
- the object's saved representation information.validate
- if true the representation must be validated and not be corrupt before being reused. If false, validation may be skipped as it will be performed elsewhere in the processing pipeline.- Throws:
IOException
- the stream's write method threw an exception. Packing will abort.StoredObjectRepresentationNotAvailableException
- the previously selected representation is no longer available. If thrown beforeout.writeHeader
the pack writer will try to find another representation, and write that one instead. If throw afterout.writeHeader
, packing will abort.
-
writeObjects
Write objects to the pack stream in roughly the order given.PackWriter
invokes this method to write out one or more objects, in approximately the order specified by the iteration over the list. A simple implementation of this method would just iterate the list and output each object:for (ObjectToPack obj : list) out.writeObject(obj)
However more sophisticated implementors may try to perform some (small) reordering to access objects that are stored close to each other at roughly the same time. Implementations may choose to write objects out of order, but this may increase pack file size due to using a larger header format to reach a delta base that is later in the stream. It may also reduce data locality for the reader, slowing down data access. InvokingPackOutputStream.writeObject(ObjectToPack)
will causeObjectReuseAsIs.copyObjectAsIs(PackOutputStream, ObjectToPack, boolean)
to be invoked recursively onthis
if the current object is scheduled for reuse.- Specified by:
writeObjects
in interfaceObjectReuseAsIs
- Parameters:
out
- the stream to write each object to.list
- the list of objects to write. Objects should be written in approximately this order. Implementors may resort the list elements in-place during writing if desired.- Throws:
IOException
- the stream cannot be written to, or one or more required objects cannot be accessed from the object database.
-
copy
Copy bytes from the window to a caller supplied buffer.- Parameters:
pack
- the file the desired window is stored within.position
- position within the file to read from.dstbuf
- destination buffer to copy into.dstoff
- offset withindstbuf
to start copying into.cnt
- number of bytes to copy. This value may exceed the number of bytes remaining in the window starting at offsetpos
.- Returns:
- number of bytes actually copied; this may be less than
cnt
ifcnt
exceeded the number of bytes available. - Throws:
IOException
- this cursor does not match the provider or id and the proper window could not be acquired through the provider's cache.
-
copyPackAsIs
Append an entire pack's contents onto the output stream.The entire pack, excluding its header and trailing footer is sent.
- Specified by:
copyPackAsIs
in interfaceObjectReuseAsIs
- Parameters:
out
- stream to append the pack onto.pack
- the cached pack to send.- Throws:
IOException
- the pack cannot be read, or stream did not accept a write.
-
copyPackAsIs
- Throws:
IOException
-
inflate
int inflate(Pack pack, long position, byte[] dstbuf, boolean headerOnly) throws IOException, DataFormatException Inflate a region of the pack starting atposition
.- Parameters:
pack
- the file the desired window is stored within.position
- position within the file to read from.dstbuf
- destination buffer the inflater should output decompressed data to. Must be large enough to store the entire stream, unless headerOnly is true.headerOnly
- if true the caller wants onlydstbuf.length
bytes.- Returns:
- number of bytes inflated into
dstbuf
. - Throws:
IOException
- this cursor does not match the provider or id and the proper window could not be acquired through the provider's cache.DataFormatException
- the inflater encountered an invalid chunk of data. Data stream corruption is likely.
-
quickCopy
- Throws:
IOException
-
inflater
Inflater inflater() -
prepareInflater
private void prepareInflater() -
pin
- Throws:
IOException
-
getCreatedFromInserter
Get theObjectInserter
from which this reader was created usinginserter.newReader()
- Overrides:
getCreatedFromInserter
in classObjectReader
- Returns:
- the
ObjectInserter
from which this reader was created usinginserter.newReader()
, or null if this reader was not created from an inserter.
-
close
public void close()Release any resources used by this reader.
A reader that has been released can be used again, but may need to be released after the subsequent usage.
Release the current window cursor.
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in classObjectReader
-