模块 org.glavo.chardet

程序包 org.glavo.chardet

类 UnicodeBOMInputStream

java.lang.Object

java.io.InputStream

org.glavo.chardet.UnicodeBOMInputStream

所有已实现的接口:

Closeable, AutoCloseable

public class UnicodeBOMInputStream
extends InputStream

The UnicodeBOMInputStream class wraps any InputStream and detects the presence of any Unicode BOM (Byte Order Mark) at its beginning, as defined by RFC 3629 - UTF-8, a transformation format of ISO 10646

The Unicode FAQ defines 5 types of BOMs:

• 00 00 FE FF  = UTF-32, big-endian

• FF FE 00 00  = UTF-32, little-endian

• FE FF        = UTF-16, big-endian

• FF FE        = UTF-16, little-endian

• EF BB BF     = UTF-8

Use the getBOM() method to know whether a BOM has been detected or not.

Use the skipBOM() method to remove the detected BOM from the wrapped InputStream object.

嵌套类概要

嵌套类

修饰符和类型	类	说明
static final class	UnicodeBOMInputStream.BOM	Type safe enumeration class that describes the different types of Unicode BOMs.

构造器概要

构造器

构造器	说明
UnicodeBOMInputStream(InputStream inputStream)	Constructs a new UnicodeBOMInputStream that wraps the specified InputStream.
UnicodeBOMInputStream(InputStream inputStream, boolean skipIfFound)	Constructs a new UnicodeBOMInputStream that wraps the specified InputStream.
UnicodeBOMInputStream(InputStream inputStream, boolean skipIfFound, boolean useMark)	Constructs a new UnicodeBOMInputStream that wraps the specified InputStream.

方法概要

修饰符和类型	方法	说明
int	available()
void	close()
final UnicodeBOMInputStream.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 UnicodeBOMInputStream	skipBOM()	Skips the BOM that was found in the wrapped InputStream object.

从类继承的方法 java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

从类继承的方法 java.lang.Object

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

构造器详细资料

UnicodeBOMInputStream

public UnicodeBOMInputStream(InputStream inputStream)
                      throws IOException

Constructs a new UnicodeBOMInputStream that wraps the specified InputStream. By default, skip BOM bytes.

参数:

inputStream - an InputStream.

抛出:

NullPointerException - when inputStream is null.

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

UnicodeBOMInputStream

public UnicodeBOMInputStream(InputStream inputStream,
 boolean skipIfFound)
                      throws IOException

Constructs a new UnicodeBOMInputStream that wraps the specified InputStream.

参数:

inputStream - an InputStream.

skipIfFound - to automatically skip BOM bytes if found

抛出:

NullPointerException - when inputStream is null.

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

UnicodeBOMInputStream

public UnicodeBOMInputStream(InputStream inputStream,
 boolean skipIfFound,
 boolean useMark)
                      throws IOException

Constructs a new UnicodeBOMInputStream that wraps the specified InputStream.

参数:

inputStream - an InputStream.

skipIfFound - to automatically skip BOM bytes if found

useMark - to select whether to call the mark/reset of the inputStream

抛出:

NullPointerException - when inputStream is null.

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

方法详细资料

getBOM

public final UnicodeBOMInputStream.BOM getBOM()

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

返回:

a BOM value.

skipBOM

public final UnicodeBOMInputStream skipBOM()
                                    throws IOException

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

返回:

this UnicodeBOMInputStream.

抛出:

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

read

public int read()
         throws IOException

指定者:

read 在类中 InputStream

抛出:

IOException

read

public int read(byte[] b)
         throws IOException

覆盖:

read 在类中 InputStream

抛出:

IOException

read

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

覆盖:

read 在类中 InputStream

抛出:

IOException

skip

public long skip(long n)
          throws IOException

覆盖:

skip 在类中 InputStream

抛出:

IOException

available

public int available()
              throws IOException

覆盖:

available 在类中 InputStream

抛出:

IOException

close

public void close()
           throws IOException

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 Closeable

覆盖:

close 在类中 InputStream

抛出:

IOException

mark

public void mark(int readlimit)

覆盖:

mark 在类中 InputStream

reset

public void reset()
           throws IOException

覆盖:

reset 在类中 InputStream

抛出:

IOException

markSupported

public boolean markSupported()

覆盖:

markSupported 在类中 InputStream