org.eclipse.jgit.lib

Class ObjectLoader.Filter

java.lang.Object

org.eclipse.jgit.lib.ObjectLoader

org.eclipse.jgit.lib.ObjectLoader.Filter

Enclosing class:

ObjectLoader

public abstract static class ObjectLoader.Filter
extends ObjectLoader

Wraps a delegate ObjectLoader.

Since:

4.10

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jgit.lib.ObjectLoader

ObjectLoader.Filter, ObjectLoader.SmallObject

Constructor Summary

Constructors

Constructor and Description
Filter()

Method Summary

Modifier and Type	Method and Description
protected abstract ObjectLoader	delegate()
byte[]	getCachedBytes() Obtain a reference to the (possibly cached) bytes of this object.
long	getSize() Get size of object in bytes
int	getType() Get Git in pack object type
boolean	isLarge() Whether this object is too large to obtain as a byte array.
ObjectStream	openStream() Obtain an input stream to read this object's data.

Methods inherited from class org.eclipse.jgit.lib.ObjectLoader

copyTo, getBytes, getBytes, getCachedBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter()

Method Detail

delegate

protected abstract ObjectLoader delegate()

Returns:

delegate ObjectLoader to handle all processing.

Since:

4.10

getType

public int getType()

Description copied from class: ObjectLoader

Get Git in pack object type

Specified by:

getType in class ObjectLoader

Returns:

Git in pack object type, see Constants.

getSize

public long getSize()

Description copied from class: ObjectLoader

Get size of object in bytes

Specified by:

getSize in class ObjectLoader

Returns:

size of object in bytes

isLarge

public boolean isLarge()

Description copied from class: ObjectLoader

Whether this object is too large to obtain as a byte array.

Overrides:

isLarge in class ObjectLoader

Returns:

true if this object is too large to obtain as a byte array. Objects over a certain threshold should be accessed only by their ObjectLoader.openStream() to prevent overflowing the JVM heap.

getCachedBytes

public byte[] getCachedBytes()

Description copied from class: ObjectLoader

Obtain a reference to the (possibly cached) bytes of this object.

This method offers direct access to the internal caches, potentially saving on data copies between the internal cache and higher level code. Callers who receive this reference must not modify its contents. Changes (if made) will affect the cache but not the repository itself.

Specified by:

getCachedBytes in class ObjectLoader

Returns:

the cached bytes of this object. Do not modify it.

openStream

public ObjectStream openStream()
                        throws IOException

Description copied from class: ObjectLoader

Obtain an input stream to read this object's data.

Specified by:

openStream in class ObjectLoader

Returns:

a stream of this object's data. Caller must close the stream when through with it. The returned stream is buffered with a reasonable buffer size.

Throws:

MissingObjectException - the object no longer exists.

IOException - the object store cannot be accessed.