net.sf.kdgcommons.io

Class BOMExclusionInputStream

java.lang.Object

java.io.InputStream

net.sf.kdgcommons.io.BOMExclusionInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BOMExclusionInputStream
extends InputStream

This class is used to wrap a UTF8-encoded stream that includes an encoded Byte Order Mark (BOM, 0xFEFF encoded as 0xEF 0xBB 0xBF) as its first bytes. Such streams are produced by various Microsoft applications. This class will automatically skip these bytes and return the subsequent byte as the first byte in the stream.

If the first byte in the stream is 0xEF, this class will attempt to read the next two bytes. Results are undefined in the stream does not contain UTF-8 encoded data, as these next two bytes may not exist.

Constructor Summary

Constructors

Constructor and Description
BOMExclusionInputStream(InputStream delegate)

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes available in the stream, including the BOM.
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] buf)
int	read(byte[] buf, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.lang.Object

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

Constructor Detail

BOMExclusionInputStream

public BOMExclusionInputStream(InputStream delegate)

Method Detail

available

public int available()
              throws IOException

Returns the number of bytes available in the stream, including the BOM. This operation does not attempt to read the stream.

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

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buf)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

markSupported

public 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

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException