uk.co.bigbeeconsultants.bconfig.io

Class BomDetectingInputStream

java.lang.Object

java.io.InputStream

uk.co.bigbeeconsultants.bconfig.io.BomDetectingInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class BomDetectingInputStream
extends java.io.InputStream

Provides an input stream that wraps another input stream and examines the first four bytes of it to detect the byte-order mark, if any. The byte-order mark is consumed; all other bytes are returned as normal.

Although this class is itself an InputStream, typical usage is to obtain a Reader using 'inputStreamReader', which constructs an InputStreamReader, using the byte-order mark if possible.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	byteOrderMark Holds the byte-order mark, if present.

Constructor Summary

Constructors

Constructor and Description
BomDetectingInputStream(java.io.InputStream in)

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
void	close()
java.io.Reader	inputStreamReader()
java.io.Reader	inputStreamReader(java.lang.String defaultCharset)
int	read()
long	skip(long n)

Methods inherited from class java.io.InputStream

mark, markSupported, read, read, reset

Methods inherited from class java.lang.Object

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

Field Detail

byteOrderMark

public final java.lang.String byteOrderMark

Holds the byte-order mark, if present. This is one of "UTF-32BE", "UTF-32LE", "UTF-16BE", "UTF-16LE", "UTF-8" or None.

Constructor Detail

BomDetectingInputStream

public BomDetectingInputStream(java.io.InputStream in)
                        throws java.io.IOException

Parameters:

in - the wrapped input stream

Throws:

java.io.IOException

Method Detail

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException

inputStreamReader

public java.io.Reader inputStreamReader()
                                 throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

inputStreamReader

public java.io.Reader inputStreamReader(java.lang.String defaultCharset)
                                 throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException