org.eclipse.jgit.internal.storage.dfs

Class LargePackedWholeObject

java.lang.Object

org.eclipse.jgit.lib.ObjectLoader

org.eclipse.jgit.internal.storage.dfs.LargePackedWholeObject

final class LargePackedWholeObject
extends ObjectLoader

Nested Class Summary

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

ObjectLoader.Filter, ObjectLoader.SmallObject

Field Summary

Fields

Modifier and Type	Field and Description
private DfsObjDatabase	db
private int	headerLength
private long	objectOffset
private DfsPackFile	pack
private long	size
private int	type

Constructor Summary

Constructors

Constructor and Description
LargePackedWholeObject(int type, long size, long objectOffset, int headerLength, DfsPackFile pack, DfsObjDatabase db)

Method Summary

Modifier and Type	Method and Description
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

Field Detail

type

private final int type

size

private final long size

objectOffset

private final long objectOffset

headerLength

private final int headerLength

pack

private final DfsPackFile pack

db

private final DfsObjDatabase db

Constructor Detail

LargePackedWholeObject

LargePackedWholeObject(int type,
                       long size,
                       long objectOffset,
                       int headerLength,
                       DfsPackFile pack,
                       DfsObjDatabase db)

Method Detail

getType

public int getType()

Get Git in pack object type

Specified by:

getType in class ObjectLoader

Returns:

Git in pack object type, see Constants.

getSize

public long getSize()

Get size of object in bytes

Specified by:

getSize in class ObjectLoader

Returns:

size of object in bytes

isLarge

public boolean isLarge()

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()
                      throws LargeObjectException

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.

Throws:

LargeObjectException - if the object won't fit into a byte array, because ObjectLoader.isLarge() returns true. Callers should use ObjectLoader.openStream() instead to access the contents.

openStream

public ObjectStream openStream()
                        throws MissingObjectException,
                               java.io.IOException

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.

java.io.IOException - the object store cannot be accessed.