pack-priv final Class WindowCursor

Implements abstract org.eclipse.jgit.lib.ObjectReader.close.

Implements java.lang.AutoCloseable.close.

Doc from org.eclipse.jgit.lib.ObjectReader.close.

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

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.

Annotations

@Override

Implements org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.copyObjectAsIs.

Doc from org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.copyObjectAsIs.

Output a previously selected representation.

PackWriter invokes this method only if a representation previously given to it by selectObjectRepresentation was chosen for reuse into the output stream. The otp argument is an instance created by this reader's own newObjectToPack, 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);

Parameters

out:PackOutputStream

stream the object should be written to.

otp:ObjectToPack

the object's saved representation information.

validate:boolean

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.

Annotations

@Override

Exceptions

IOException:

the stream's write method threw an exception. Packing will abort.

StoredObjectRepresentationNotAvailableException:

the previously selected representation is no longer available. If thrown before out.writeHeader the pack writer will try to find another representation, and write that one instead. If throw after out.writeHeader, packing will abort.

Implements org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.copyPackAsIs.

Doc from org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.copyPackAsIs.

Append an entire pack's contents onto the output stream.

The entire pack, excluding its header and trailing footer is sent.

Parameters

out:PackOutputStream

stream to append the pack onto.

pack:CachedPack

the cached pack to send.

Annotations

@Override

Exceptions

IOException:

the pack cannot be read, or stream did not accept a write.

Overrides org.eclipse.jgit.lib.ObjectReader.getBitmapIndex.

Doc from org.eclipse.jgit.lib.ObjectReader.getBitmapIndex.

An index that can be used to speed up ObjectWalks.

Returns:BitmapIndex

the index or null if one does not exist.

Annotations

@Override

Exceptions

IOException:

when the index fails to load

Implements org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.getCachedPacksAndUpdate.

Doc from org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.getCachedPacksAndUpdate.

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.

Parameters

needBitmap:BitmapIndex.BitmapBuilder

the bitmap that contains all of the objects the client wants.

Returns:Collection<CachedPack>

the available cached packs.

Annotations

@Override

Exceptions

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.

Overrides org.eclipse.jgit.lib.ObjectReader.getCommitGraph.

Doc from org.eclipse.jgit.lib.ObjectReader.getCommitGraph.

Get the commit-graph for this repository if available.

The commit graph can be created/modified/deleted while the repository is open and specific implementations decide when to refresh it.

Returns:Optional<CommitGraph>

the commit-graph or empty if the commit-graph does not exist or is invalid; always returns empty when core.commitGraph is false (default is false).

Annotations

@Override

Overrides org.eclipse.jgit.lib.ObjectReader.getCreatedFromInserter.

Doc from org.eclipse.jgit.lib.ObjectReader.getCreatedFromInserter.

Get the org.eclipse.jgit.lib.ObjectInserter from which this reader was created using inserter.newReader()

Returns:ObjectInserter

the org.eclipse.jgit.lib.ObjectInserter from which this reader was created using inserter.newReader(), or null if this reader was not created from an inserter.

Annotations

@Override

@Nullable

Overrides org.eclipse.jgit.lib.ObjectReader.getObjectSize.

Doc from org.eclipse.jgit.lib.ObjectReader.getObjectSize.

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.

Parameters

objectId:AnyObjectId

identity of the object to open.

typeHint:int

hint about the type of object being requested, e.g. org.eclipse.jgit.lib.Constants#OBJ_BLOB; OBJ_ANY if the object type is not known, or does not matter to the caller.

Returns:long

size of object in bytes.

Annotations

@Override

Exceptions

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.

Implements abstract org.eclipse.jgit.lib.ObjectReader.getShallowCommits.

Doc from org.eclipse.jgit.lib.ObjectReader.getShallowCommits.

Returns IDs for those commits which should be considered as shallow.

Returns:Set<ObjectId>

IDs of shallow commits

Annotations

@Override

Exceptions

IOException:

if an error occurred

Overrides org.eclipse.jgit.lib.ObjectReader.has.

Doc from org.eclipse.jgit.lib.ObjectReader.has.

Does the requested object exist in this database?

Parameters

objectId:AnyObjectId

identity of the object to test for existence of.

Returns:boolean

true if the specified object is stored in this database.

Annotations

@Override

Exceptions

IOException:

the object store cannot be accessed.

Implements org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.newObjectToPack.

Doc from org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.newObjectToPack.

Allocate a new PackWriter state structure for an object.

org.eclipse.jgit.internal.storage.pack.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.

Parameters

objectId:AnyObjectId

the id of the object that will be packed.

type:int

the Git type of the object that will be packed.

Returns:LocalObjectToPack

a new instance for this object.

Annotations

@Override

Implements abstract org.eclipse.jgit.lib.ObjectReader.newReader.

Doc from org.eclipse.jgit.lib.ObjectReader.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.

Returns:ObjectReader

a brand new reader, using the same data source.

Annotations

@Override

Implements abstract org.eclipse.jgit.lib.ObjectReader.open.

Doc from org.eclipse.jgit.lib.ObjectReader.open.

Open an object from this database.

Parameters

objectId:AnyObjectId

identity of the object to open.

typeHint:int

hint about the type of object being requested, e.g. org.eclipse.jgit.lib.Constants#OBJ_BLOB; OBJ_ANY if the object type is not known, or does not matter to the caller.

Returns:ObjectLoader

a org.eclipse.jgit.lib.ObjectLoader for accessing the object.

Annotations

@Override

Exceptions

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.

Implements abstract org.eclipse.jgit.lib.ObjectReader.resolve.

Doc from org.eclipse.jgit.lib.ObjectReader.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.

Parameters

id:AbbreviatedObjectId

abbreviated id to resolve to a complete identity. The abbreviation must have a length of at least 2.

Returns:Collection<ObjectId>

candidates that begin with the abbreviated identity.

Annotations

@Override

Exceptions

IOException:

the object store cannot be read.

Implements org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.selectObjectRepresentation.

Doc from org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.selectObjectRepresentation.

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 org.eclipse.jgit.internal.storage.pack.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 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.

Parameters

packer:PackWriter

the packer that will write the object in the near future.

monitor:ProgressMonitor

progress monitor, implementation should update the monitor once for each item in the iteration when selection is done.

objects:Iterable<ObjectToPack>

the objects that are being packed.

Annotations

@Override

Exceptions

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.

Implements org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.writeObjects.

Doc from org.eclipse.jgit.internal.storage.pack.ObjectReuseAsIs.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)

Parameters

out:PackOutputStream

the stream to write each object to.

list:List<ObjectToPack>

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.

Annotations

@Override

Exceptions

IOException:

the stream cannot be written to, or one or more required objects cannot be accessed from the object database.