io.earcam.utilitarian.io

Class MarkSupportedInputStream

java.lang.Object

java.io.InputStream

io.earcam.utilitarian.io.MarkSupportedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class MarkSupportedInputStream
extends InputStream

Wraps an InputStream to ensure InputStream.markSupported() returns true.

Note: if calls to read() exceed the readLimit parameter of mark(int) then the mark is removed and a call to reset() will throw an IOException.

Constructor Summary

Constructors

Constructor and Description
MarkSupportedInputStream(InputStream delegate) Create an InputStream with mark supported

Method Summary

Modifier and Type	Method and Description
static InputStream	ensureMarkSupported(InputStream input) For efficient use of memory, this convenience static method returns the input argument IFF it claims to to support marking, otherwise the stream is wrapped
void	mark(int readLimit)
boolean	markSupported()
int	read()
void	reset()

Methods inherited from class java.io.InputStream

available, close, read, read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkSupportedInputStream

public MarkSupportedInputStream(InputStream delegate)

Create an InputStream with mark supported

Parameters:

delegate - the InputStream to wrap

Method Detail

ensureMarkSupported

public static InputStream ensureMarkSupported(InputStream input)

For efficient use of memory, this convenience static method returns the input argument IFF it claims to to support marking, otherwise the stream is wrapped

Parameters:

input - the InputStream to check

Returns:

an InputStream that supports marking

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

markSupported

public final 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