Class MarkableNullInputStream

java.lang.Object

java.io.InputStream

de.xima.fc.common.io.MarkableNullInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class MarkableNullInputStream
extends InputStream

An InputStream that is always empty and markable / resettable. InputStream.nullInputStream() is not markable, this one is. Some use cases such as the ICU4J library require markable input streams.

Since:

8.3.0

Author:

XIMA Media GmbH

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	mark(int readLimit)
static InputStream	markableNullInputStream()	Gets a new instance of a markable null input stream.
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
byte[]	readAllBytes()
int	readNBytes(byte[] b, int off, int len)
byte[]	readNBytes(int len)
void	reset()
long	skip(long n)
long	transferTo(OutputStream out)

Methods inherited from class InputStream

nullInputStream, read

Methods inherited from class Object

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

Method Details

available

public int available()
              throws IOException

Overrides:

available 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

mark

public void mark(int readLimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

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

readAllBytes

public byte[] readAllBytes()
                    throws IOException

Overrides:

readAllBytes in class InputStream

Throws:

IOException

readNBytes

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

Overrides:

readNBytes in class InputStream

Throws:

IOException

readNBytes

public byte[] readNBytes(int len)
                  throws IOException

Overrides:

readNBytes in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

transferTo

public long transferTo(OutputStream out)
                throws IOException

Overrides:

transferTo in class InputStream

Throws:

IOException

markableNullInputStream

public static InputStream markableNullInputStream()

Gets a new instance of a markable null input stream.

Returns:

A new instance of a markable null input stream.