Package com.stimulsoft.lib.io

Class StiUnicodeBOMInputStream

java.lang.Object

java.io.InputStream

com.stimulsoft.lib.io.StiUnicodeBOMInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class StiUnicodeBOMInputStream
extends InputStream

Copyright Stimulsoft

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StiUnicodeBOMInputStream.BOM

Constructor Summary

Constructors

Constructor	Description
StiUnicodeBOMInputStream(InputStream inputStream)	Constructs a new UnicodeBOMInputStream that wraps the specified InputStream.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
final StiUnicodeBOMInputStream.BOM	getBOM()	Returns the BOM that was detected in the wrapped InputStream object.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)
final StiUnicodeBOMInputStream	skipBOM()	Skips the BOM that was found in the wrapped InputStream object.

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

StiUnicodeBOMInputStream

public StiUnicodeBOMInputStream(InputStream inputStream)
                         throws NullPointerException,
IOException

Constructs a new UnicodeBOMInputStream that wraps the specified InputStream.

Parameters:

inputStream - an InputStream.

Throws:

NullPointerException - when inputStream is null.

IOException - on reading from the specified InputStream when trying to detect the Unicode BOM.

Method Details

getBOM

public final StiUnicodeBOMInputStream.BOM getBOM()

Returns the BOM that was detected in the wrapped InputStream object.

Returns:

a BOM value.

skipBOM

public final StiUnicodeBOMInputStream skipBOM()
                                       throws IOException

Skips the BOM that was found in the wrapped InputStream object.

Returns:

this UnicodeBOMInputStream.

Throws:

IOException - when trying to skip the BOM from the wrapped InputStream object.

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

NullPointerException

read

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

Overrides:

read in class InputStream

Throws:

IOException

NullPointerException

skip

public long skip(long n)
          throws IOException

Overrides:

skip 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 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

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream