eve.io

Class MarkableStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

eve.io.MarkableStream

public class MarkableStream
extends FilterInputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
MarkableStream(InputStream input)

Method Summary

Modifier and Type	Method and Description
void	mark(int readLimit) Calls the in.mark(int) method.
boolean	markSupported() Calls the in.markSupported() method.
int	read() Calls the in.read() method
int	read(byte[] dest, int offset, int count) Calls the in.read(byte[], int, int) method.
void	reset() Calls the in.reset() method.
long	skip(long num) Rewind a Stream created by toRewindableStream().
static InputStream	toMarkableStream(InputStream input)

Methods inherited from class java.io.FilterInputStream

available, close, read

Methods inherited from class java.io.InputStream

finalize, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkableStream

public MarkableStream(InputStream input)

Method Detail

read

public int read()
         throws IOException

Description copied from class: FilterInputStream

Calls the in.read() method

Overrides:

read in class FilterInputStream

Returns:

The value returned from in.read()

Throws:

IOException - If an error occurs

read

public int read(byte[] dest,
                int offset,
                int count)
         throws IOException

Description copied from class: FilterInputStream

Calls the in.read(byte[], int, int) method.

Overrides:

read in class FilterInputStream

Parameters:

dest - The buffer to read bytes into

offset - The index into the buffer to start storing bytes

count - The maximum number of bytes to read.

Returns:

The value retured from in.read(byte[], int, int)

Throws:

IOException - If an error occurs

markSupported

public boolean markSupported()

Description copied from class: FilterInputStream

Calls the in.markSupported() method.

Overrides:

markSupported in class FilterInputStream

Returns:

true if mark/reset is supported, false otherwise

mark

public void mark(int readLimit)

Description copied from class: FilterInputStream

Calls the in.mark(int) method.

Overrides:

mark in class FilterInputStream

Parameters:

readLimit - The parameter passed to in.mark(int)

reset

public void reset()
           throws IOException

Description copied from class: FilterInputStream

Calls the in.reset() method.

Overrides:

reset in class FilterInputStream

Throws:

IOException - If an error occurs

toMarkableStream

public static InputStream toMarkableStream(InputStream input)

skip

public long skip(long num)
          throws IOException

Rewind a Stream created by toRewindableStream(). From that point you will be reading from the start of the stream again.

Overrides:

skip in class FilterInputStream

Parameters:

stream - the RandomStream returned by toRewindableStream().

Returns:

The value returned from in.skip(long)

Throws:

IOException - if an IO error occurs.