UnicodeInputStream (bboss-velocity 6.1.5 API)

java.lang.Object
- java.io.InputStream
- - bboss.org.apache.velocity.io.UnicodeInputStream

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable
```
public class UnicodeInputStream
extends java.io.InputStream
```
This is an input stream that is unicode BOM aware. This allows you to e.g. read Windows Notepad Unicode files as Velocity templates. It allows you to check the actual encoding of a file by calling getEncodingFromStream() on the input stream reader. This class is not thread safe! When more than one thread wants to use an instance of UnicodeInputStream, the caller must provide synchronization.

从以下版本开始:

1.5

字段概要

字段
限定符和类型	字段和说明
`static bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM`	`UTF16BE_BOM` BOM Marker for UTF 16, big endian.
`static bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM`	`UTF16LE_BOM` BOM Marker for UTF 16, little endian.
`static bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM`	`UTF32BE_BOM` BOM Marker for UTF 32, big endian.
`static bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM`	`UTF32LE_BOM` BOM Marker for UTF 32, little endian.
`static bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM`	`UTF8_BOM` BOM Marker for UTF 8.

构造器概要

构造器
构造器和说明
`UnicodeInputStream(java.io.InputStream inputStream)` Creates a new UnicodeInputStream object.
`UnicodeInputStream(java.io.InputStream inputStream, boolean skipBOM)` Creates a new UnicodeInputStream object.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int`	`available()`
`void`	`close()`
`java.lang.String`	`getEncodingFromStream()` Read encoding based on BOM.
`boolean`	`isSkipBOM()` Returns true if the input stream discards the BOM.
`void`	`mark(int readlimit)`
`boolean`	`markSupported()`
`int`	`read()`
`int`	`read(byte[] b)`
`int`	`read(byte[] b, int off, int len)`
`protected java.lang.String`	`readEncoding()` This method gets the encoding from the stream contents if a BOM exists.
`void`	`reset()`
`long`	`skip(long n)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - UTF8_BOM
```
public static final bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM UTF8_BOM
```
    BOM Marker for UTF 8. See http://www.unicode.org/unicode/faq/utf_bom.html
  - UTF16LE_BOM
```
public static final bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM UTF16LE_BOM
```
    BOM Marker for UTF 16, little endian. See http://www.unicode.org/unicode/faq/utf_bom.html
  - UTF16BE_BOM
```
public static final bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM UTF16BE_BOM
```
    BOM Marker for UTF 16, big endian. See http://www.unicode.org/unicode/faq/utf_bom.html
  - UTF32LE_BOM
```
public static final bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM UTF32LE_BOM
```
    BOM Marker for UTF 32, little endian. See http://www.unicode.org/unicode/faq/utf_bom.html TODO: Does Java actually support this?
  - UTF32BE_BOM
```
public static final bboss.org.apache.velocity.io.UnicodeInputStream.UnicodeBOM UTF32BE_BOM
```
    BOM Marker for UTF 32, big endian. See http://www.unicode.org/unicode/faq/utf_bom.html TODO: Does Java actually support this?
- 构造器详细资料
  - UnicodeInputStream
```
public UnicodeInputStream(java.io.InputStream inputStream)
                   throws java.lang.IllegalStateException,
                          java.io.IOException
```
    Creates a new UnicodeInputStream object. Skips a BOM which defines the file encoding.
    
    参数:
    
    inputStream - The input stream to use for reading.
    
    抛出:
    
    java.lang.IllegalStateException
    
    java.io.IOException
  - UnicodeInputStream
```
public UnicodeInputStream(java.io.InputStream inputStream,
                          boolean skipBOM)
                   throws java.lang.IllegalStateException,
                          java.io.IOException
```
    Creates a new UnicodeInputStream object.
    
    参数:
    
    inputStream - The input stream to use for reading.
    
    skipBOM - If this is set to true, a BOM read from the stream is discarded. This parameter should normally be true.
    
    抛出:
    
    java.lang.IllegalStateException
    
    java.io.IOException
- 方法详细资料
  - isSkipBOM
```
public boolean isSkipBOM()
```
    Returns true if the input stream discards the BOM.
    
    返回:
    
    True if the input stream discards the BOM.
  - getEncodingFromStream
```
public java.lang.String getEncodingFromStream()
```
    Read encoding based on BOM.
    
    返回:
    
    The encoding based on the BOM.
    
    抛出:
    
    java.lang.IllegalStateException - When a problem reading the BOM occured.
  - readEncoding
```
protected java.lang.String readEncoding()
                                 throws java.io.IOException
```
    This method gets the encoding from the stream contents if a BOM exists. If no BOM exists, the encoding is undefined.
    
    返回:
    
    The encoding of this streams contents as decided by the BOM or null if no BOM was found.
    
    抛出:
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    指定者:
    
    close 在接口中 java.io.Closeable
    
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
    
    覆盖:
    
    close 在类中 java.io.InputStream
    
    抛出:
    
    java.io.IOException
    
    另请参阅:
    
    InputStream.close()
  - available
```
public int available()
              throws java.io.IOException
```
    覆盖:
    
    available 在类中 java.io.InputStream
    
    抛出:
    
    java.io.IOException
    
    另请参阅:
    
    InputStream.available()
  - mark
```
public void mark(int readlimit)
```
    覆盖:
    
    mark 在类中 java.io.InputStream
    
    另请参阅:
    
    InputStream.mark(int)
  - markSupported
```
public boolean markSupported()
```
    覆盖:
    
    markSupported 在类中 java.io.InputStream
    
    另请参阅:
    
    InputStream.markSupported()
  - read
```
public int read()
         throws java.io.IOException
```
    指定者:
    
    read 在类中 java.io.InputStream
    
    抛出:
    
    java.io.IOException
    
    另请参阅:
    
    InputStream.read()
  - read
```
public int read(byte[] b)
         throws java.io.IOException
```
    覆盖:
    
    read 在类中 java.io.InputStream
    
    抛出:
    
    java.io.IOException
    
    另请参阅:
    
    InputStream.read(byte[])
  - read
```
public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException
```
    覆盖:
    
    read 在类中 java.io.InputStream
    
    抛出:
    
    java.io.IOException
    
    另请参阅:
    
    InputStream.read(byte[], int, int)
  - reset
```
public void reset()
           throws java.io.IOException
```
    覆盖:
    
    reset 在类中 java.io.InputStream
    
    抛出:
    
    java.io.IOException
    
    另请参阅:
    
    InputStream.reset()
  - skip
```
public long skip(long n)
          throws java.io.IOException
```
    覆盖:
    
    skip 在类中 java.io.InputStream
    
    抛出:
    
    java.io.IOException
    
    另请参阅:
    
    InputStream.skip(long)

类 UnicodeInputStream

字段概要

构造器概要

方法概要

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

字段详细资料

UTF8_BOM

UTF16LE_BOM

UTF16BE_BOM

UTF32LE_BOM

UTF32BE_BOM

构造器详细资料

UnicodeInputStream

UnicodeInputStream

方法详细资料

isSkipBOM

getEncodingFromStream

readEncoding

close

available

mark

markSupported

read

read

read

reset

skip