Module org.eclipse.jgit

Package org.eclipse.jgit.lib

Class ObjectStream.Filter

java.lang.Object

java.io.InputStream

org.eclipse.jgit.lib.ObjectStream

org.eclipse.jgit.lib.ObjectStream.Filter

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

ObjectStream

public static class ObjectStream.Filter
extends ObjectStream

Simple filter stream around another stream.

ObjectLoader implementations can use this stream type when the object's content is available from a standard InputStream.

Nested Class Summary

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

ObjectStream.Filter, ObjectStream.SmallStream

Constructor Summary

Constructors

Constructor	Description
Filter(int type, long size, InputStream in)	Create a filter stream for an object.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
long	getSize()	Get total size of object in bytes
int	getType()	Get Git object type, see Constants.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.InputStream

nullInputStream, read, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter(int type,
              long size,
              InputStream in)

Create a filter stream for an object.

Parameters:

type - the type of the object.

size - total size of the object, in bytes.

in - stream the object's raw data is available from. This stream should be buffered with some reasonable amount of buffering.

Method Detail

getType

public int getType()

Description copied from class: ObjectStream

Get Git object type, see Constants.

Specified by:

getType in class ObjectStream

Returns:

Git object type, see Constants.

getSize

public long getSize()

Description copied from class: ObjectStream

Get total size of object in bytes

Specified by:

getSize in class ObjectStream

Returns:

total size of object in bytes

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException