com.ctc.wstx.io
Class UTF8Reader

java.lang.Object
  extended by java.io.Reader
      extended by com.ctc.wstx.io.UTF8Reader
All Implemented Interfaces:
Closeable, Readable

public final class UTF8Reader
extends Reader

Optimized Reader that reads UTF-8 encoded content from an input stream. In addition to doing (hopefully) optimal conversion, it can also take array of "pre-read" (leftover) bytes; this is necessary when preliminary stream/reader is trying to figure out XML encoding.


Field Summary
protected static char CONVERT_LSEP_TO
          In xml 1.1, LSEP bit like \n, or \r.
protected static char CONVERT_NEL_TO
          In xml 1.1, NEL (0x85) behaves much the way \n does (can be follow \r as part of the linefeed
protected  byte[] mByteBuffer
           
protected  int mByteBufferEnd
          Pointed to the end marker, that is, position one after the last valid available byte.
protected  int mBytePtr
          Pointer to the next available byte (if any), iff less than mByteBufferEnd
protected  ReaderConfig mConfig
           
protected static char NULL_BYTE
           
protected static char NULL_CHAR
           
 
Fields inherited from class java.io.Reader
lock
 
Constructor Summary
UTF8Reader(ReaderConfig cfg, InputStream in, byte[] buf, int ptr, int len, boolean recycleBuffer)
           
 
Method Summary
protected  boolean canModifyBuffer()
          Method that can be used to see if we can actually modify the underlying buffer.
 void close()
           
 void freeBuffers()
          This method should be called along with (or instead of) normal close.
protected  InputStream getStream()
           
 int read()
          Although this method is implemented by the base class, AND it should never be called by Woodstox code, let's still implement it bit more efficiently just in case
 int read(char[] cbuf, int start, int len)
           
protected  int readBytes()
          Method for reading as many bytes from the underlying stream as possible (that fit in the buffer), to the beginning of the buffer.
protected  int readBytesAt(int offset)
          Method for reading as many bytes from the underlying stream as possible (that fit in the buffer considering offset), to the specified offset.
protected  void reportBounds(char[] cbuf, int start, int len)
           
protected  void reportInvalidXml11(int value, int bytePos, int charPos)
           
protected  void reportStrangeStream()
           
 void setXmlCompliancy(int xmlVersion)
          Method that can be called to indicate the xml conformance used when reading content using this reader.
 
Methods inherited from class java.io.Reader
mark, markSupported, read, read, ready, reset, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NULL_CHAR

protected static final char NULL_CHAR
See Also:
Constant Field Values

NULL_BYTE

protected static final char NULL_BYTE
See Also:
Constant Field Values

CONVERT_NEL_TO

protected static final char CONVERT_NEL_TO
In xml 1.1, NEL (0x85) behaves much the way \n does (can be follow \r as part of the linefeed

See Also:
Constant Field Values

CONVERT_LSEP_TO

protected static final char CONVERT_LSEP_TO
In xml 1.1, LSEP bit like \n, or \r. Need to choose one as the result. Let's use \n, for simplicity

See Also:
Constant Field Values

mConfig

protected final ReaderConfig mConfig

mByteBuffer

protected byte[] mByteBuffer

mBytePtr

protected int mBytePtr
Pointer to the next available byte (if any), iff less than mByteBufferEnd


mByteBufferEnd

protected int mByteBufferEnd
Pointed to the end marker, that is, position one after the last valid available byte.

Constructor Detail

UTF8Reader

public UTF8Reader(ReaderConfig cfg,
                  InputStream in,
                  byte[] buf,
                  int ptr,
                  int len,
                  boolean recycleBuffer)
Method Detail

setXmlCompliancy

public void setXmlCompliancy(int xmlVersion)
Method that can be called to indicate the xml conformance used when reading content using this reader. Some of the character validity checks need to be done at reader level, and sometimes they depend on xml level (for example, xml 1.1 has new linefeeds and both more and less restricted characters).


read

public int read(char[] cbuf,
                int start,
                int len)
         throws IOException
Specified by:
read in class Reader
Throws:
IOException

canModifyBuffer

protected final boolean canModifyBuffer()
Method that can be used to see if we can actually modify the underlying buffer. This is the case if we are managing the buffer, but not if it was just given to us.


close

public void close()
           throws IOException
Specified by:
close in interface Closeable
Specified by:
close in class Reader
Throws:
IOException

read

public int read()
         throws IOException
Although this method is implemented by the base class, AND it should never be called by Woodstox code, let's still implement it bit more efficiently just in case

Overrides:
read in class Reader
Throws:
IOException

getStream

protected final InputStream getStream()

readBytes

protected final int readBytes()
                       throws IOException
Method for reading as many bytes from the underlying stream as possible (that fit in the buffer), to the beginning of the buffer.

Throws:
IOException

readBytesAt

protected final int readBytesAt(int offset)
                         throws IOException
Method for reading as many bytes from the underlying stream as possible (that fit in the buffer considering offset), to the specified offset.

Returns:
Number of bytes read, if any; -1 to indicate none available (that is, end of input)
Throws:
IOException

freeBuffers

public final void freeBuffers()
This method should be called along with (or instead of) normal close. After calling this method, no further reads should be tried. Method will try to recycle read buffers (if any).


reportBounds

protected void reportBounds(char[] cbuf,
                            int start,
                            int len)
                     throws IOException
Throws:
IOException

reportStrangeStream

protected void reportStrangeStream()
                            throws IOException
Throws:
IOException

reportInvalidXml11

protected void reportInvalidXml11(int value,
                                  int bytePos,
                                  int charPos)
                           throws IOException
Throws:
IOException


Copyright © 2011 Codehaus. All Rights Reserved.