org.apache.jackrabbit.core.data.db

Class DbInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.ProxyInputStream

org.apache.commons.io.input.AutoCloseInputStream

org.apache.jackrabbit.core.data.db.DbInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class DbInputStream
extends AutoCloseInputStream

This class represents an input stream backed by a database. The database objects are only acquired when reading from the stream, and stay open until the stream is closed, fully read, or garbage collected.

This class does not support mark/reset. It is always to be wrapped using a BufferedInputStream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close() When the stream is consumed, the database objects held by the instance are closed.
void	mark(int readlimit) This method does nothing.
boolean	markSupported() Check whether mark and reset are supported.
int	read() When the stream is consumed, the database objects held by the instance are closed.
int	read(byte[] b) When the stream is consumed, the database objects held by the instance are closed.
int	read(byte[] b, int off, int len) When the stream is consumed, the database objects held by the instance are closed.
void	reset() This method does nothing.
long	skip(long n)

Methods inherited from class java.lang.Object

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

Method Detail

read

public int read()
         throws IOException

When the stream is consumed, the database objects held by the instance are closed.

Overrides:

read in class ProxyInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

When the stream is consumed, the database objects held by the instance are closed.

Overrides:

read in class ProxyInputStream

Throws:

IOException

read

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

When the stream is consumed, the database objects held by the instance are closed.

Overrides:

read in class ProxyInputStream

Throws:

IOException

close

public void close()
           throws IOException

When the stream is consumed, the database objects held by the instance are closed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AutoCloseInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class ProxyInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class ProxyInputStream

Throws:

IOException

mark

public void mark(int readlimit)

This method does nothing.

Overrides:

mark in class ProxyInputStream

reset

public void reset()
           throws IOException

This method does nothing.

Overrides:

reset in class ProxyInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Check whether mark and reset are supported.

Overrides:

markSupported in class ProxyInputStream

Returns:

false