|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.InputStream
java.io.FilterInputStream
org.apache.commons.io.input.ProxyInputStream
org.apache.commons.io.input.BOMInputStream
public class BOMInputStream
This class is used to wrap a stream that includes an encoded
ByteOrderMark
as its first bytes.
This class detects these bytes and, if required, can automatically skip them
and return the subsequent byte as the first byte in the stream.
The ByteOrderMark
implementation has the following pre-defined BOMs:
ByteOrderMark.UTF_8
ByteOrderMark.UTF_16LE
ByteOrderMark.UTF_16BE
BOMInputStream bomIn = new BOMInputStream(in); if (bomIn.hasBOM()) { // has a UTF-8 BOM }
boolean include = true; BOMInputStream bomIn = new BOMInputStream(in, include); if (bomIn.hasBOM()) { // has a UTF-8 BOM }
BOMInputStream bomIn = new BOMInputStream(in, ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_16BE); if (bomIn.hasBOM() == false) { // No BOM found } else if (bomIn.hasBOM(ByteOrderMark.UTF_16LE)) { // has a UTF-16LE BOM } else if (bomIn.hasBOM(ByteOrderMark.UTF_16BE)) { // has a UTF-16BE BOM }
ByteOrderMark
,
Wikipedia - Byte Order MarkField Summary |
---|
Fields inherited from class java.io.FilterInputStream |
---|
in |
Constructor Summary | |
---|---|
BOMInputStream(java.io.InputStream delegate)
Constructs a new BOM InputStream that excludes a ByteOrderMark.UTF_8 BOM. |
|
BOMInputStream(java.io.InputStream delegate,
boolean include)
Constructs a new BOM InputStream that detects a a ByteOrderMark.UTF_8 and optionally includes it. |
|
BOMInputStream(java.io.InputStream delegate,
boolean include,
ByteOrderMark... boms)
Constructs a new BOM InputStream that detects the specified BOMs and optionally includes them. |
|
BOMInputStream(java.io.InputStream delegate,
ByteOrderMark... boms)
Constructs a new BOM InputStream that excludes the specified BOMs. |
Method Summary | |
---|---|
ByteOrderMark |
getBOM()
Return the BOM (Byte Order Mark). |
java.lang.String |
getBOMCharsetName()
Return the BOM charset Name - ByteOrderMark.getCharsetName() . |
boolean |
hasBOM()
Indicates whether the stream contains one of the specified BOMs. |
boolean |
hasBOM(ByteOrderMark bom)
Indicates whether the stream contains the specified BOM. |
void |
mark(int readlimit)
Invokes the delegate's mark(int) method. |
int |
read()
Invokes the delegate's read() method, detecting and
optionally skipping BOM. |
int |
read(byte[] buf)
Invokes the delegate's read(byte[]) method, detecting and
optionally skipping BOM. |
int |
read(byte[] buf,
int off,
int len)
Invokes the delegate's read(byte[], int, int) method, detecting
and optionally skipping BOM. |
void |
reset()
Invokes the delegate's reset() method. |
long |
skip(long n)
Invokes the delegate's skip(long) method, detecting
and optionallyskipping BOM. |
Methods inherited from class org.apache.commons.io.input.ProxyInputStream |
---|
afterRead, available, beforeRead, close, handleIOException, markSupported |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BOMInputStream(java.io.InputStream delegate)
ByteOrderMark.UTF_8
BOM.
delegate
- the InputStream to delegate topublic BOMInputStream(java.io.InputStream delegate, boolean include)
ByteOrderMark.UTF_8
and optionally includes it.
delegate
- the InputStream to delegate toinclude
- true to include the UTF-8 BOM or
false to exclude itpublic BOMInputStream(java.io.InputStream delegate, ByteOrderMark... boms)
delegate
- the InputStream to delegate toboms
- The BOMs to detect and excludepublic BOMInputStream(java.io.InputStream delegate, boolean include, ByteOrderMark... boms)
delegate
- the InputStream to delegate toinclude
- true to include the specified BOMs or
false to exclude themboms
- The BOMs to detect and optionally excludeMethod Detail |
---|
public boolean hasBOM() throws java.io.IOException
java.io.IOException
- if an error reading the first bytes of the stream occurspublic boolean hasBOM(ByteOrderMark bom) throws java.io.IOException
bom
- The BOM to check for
java.lang.IllegalArgumentException
- if the BOM is not one the stream
is configured to detect
java.io.IOException
- if an error reading the first bytes of the stream occurspublic ByteOrderMark getBOM() throws java.io.IOException
java.io.IOException
- if an error reading the first bytes of the stream occurspublic java.lang.String getBOMCharsetName() throws java.io.IOException
ByteOrderMark.getCharsetName()
.
java.io.IOException
- if an error reading the first bytes of the stream occurspublic int read() throws java.io.IOException
read()
method, detecting and
optionally skipping BOM.
read
in class ProxyInputStream
java.io.IOException
- if an I/O error occurspublic int read(byte[] buf, int off, int len) throws java.io.IOException
read(byte[], int, int)
method, detecting
and optionally skipping BOM.
read
in class ProxyInputStream
buf
- the buffer to read the bytes intooff
- The start offsetlen
- The number of bytes to read (excluding BOM)
java.io.IOException
- if an I/O error occurspublic int read(byte[] buf) throws java.io.IOException
read(byte[])
method, detecting and
optionally skipping BOM.
read
in class ProxyInputStream
buf
- the buffer to read the bytes into
java.io.IOException
- if an I/O error occurspublic void mark(int readlimit)
mark(int)
method.
mark
in class ProxyInputStream
readlimit
- read ahead limitpublic void reset() throws java.io.IOException
reset()
method.
reset
in class ProxyInputStream
java.io.IOException
- if an I/O error occurspublic long skip(long n) throws java.io.IOException
skip(long)
method, detecting
and optionallyskipping BOM.
skip
in class ProxyInputStream
n
- the number of bytes to skip
java.io.IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |