org.apache.james.mailbox.store.streaming

Class BodyOffsetInputStream

java.lang.Object

java.io.InputStream

org.apache.james.mailbox.store.streaming.BodyOffsetInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BodyOffsetInputStream
extends InputStream

InputStream which helps to keep track of the BodyOffset of the wrapped InputStream IMPORTANT: This class is not thread-safe!

Constructor Summary

Constructors

Constructor and Description
BodyOffsetInputStream(InputStream in)

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
void	close()
long	getBodyStartOffset() Return the bodyStartOffset or -1 if it could not be found.
long	getReadBytes() Return the read bytes so far
void	mark(int readlimit)
boolean	markSupported() Mark is not supported by this implementation
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset() Throws IOException
long	skip(long n)

Methods inherited from class java.lang.Object

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

Constructor Detail

BodyOffsetInputStream

public BodyOffsetInputStream(InputStream in)

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

See Also:

InputStream.read()

read

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

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Mark is not supported by this implementation

Overrides:

markSupported in class InputStream

reset

public void reset()
           throws IOException

Throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

getBodyStartOffset

public long getBodyStartOffset()

Return the bodyStartOffset or -1 if it could not be found. Be aware you can only expect some valid result from the method if you have consumed the whole InputStream or if you are sure that you reached the body

Returns:

offset

getReadBytes

public long getReadBytes()

Return the read bytes so far

Returns:

readBytes