BEA Systems, Inc.

BEA WebLogic Server 9.1 API Reference


weblogic.apache.xerces.impl.io
Class UTF8Reader

java.lang.Object
  extended byjava.io.Reader
      extended byweblogic.apache.xerces.impl.io.UTF8Reader
All Implemented Interfaces:
Closeable, Readable

Deprecated. please use JDK supplied XML parsers and transformers

public class UTF8Reader
extends Reader


Field Summary
static int DEFAULT_BUFFER_SIZE
          Deprecated. Default byte buffer size (2048).
protected  byte[] fBuffer
          Deprecated. Byte buffer.
protected  InputStream fInputStream
          Deprecated. Input stream.
protected  int fOffset
          Deprecated. Offset into buffer.
 
Fields inherited from class java.io.Reader
lock
 
Constructor Summary
UTF8Reader(InputStream inputStream)
          Deprecated. Constructs a UTF-8 reader from the specified input stream using the default buffer size.
UTF8Reader(InputStream inputStream, int size, MessageFormatter messageFormatter, Locale locale)
          Deprecated. Constructs a UTF-8 reader from the specified input stream, buffer size and MessageFormatter.
UTF8Reader(InputStream inputStream, MessageFormatter messageFormatter, Locale locale)
          Deprecated. Constructs a UTF-8 reader from the specified input stream using the default buffer size and the given MessageFormatter.
 
Method Summary
 void close()
          Deprecated. Close the stream.
 void mark(int readAheadLimit)
          Deprecated. Mark the present position in the stream.
 boolean markSupported()
          Deprecated. Tell whether this stream supports the mark() operation.
 int read()
          Deprecated. Read a single character.
 int read(char[] ch, int offset, int length)
          Deprecated. Read characters into a portion of an array.
 boolean ready()
          Deprecated. Tell whether this stream is ready to be read.
 void reset()
          Deprecated. Reset the stream.
 long skip(long n)
          Deprecated. Skip characters.
 
Methods inherited from class java.io.Reader
read, read
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE
Deprecated. 
Default byte buffer size (2048).

See Also:
Constant Field Values

fBuffer

protected byte[] fBuffer
Deprecated. 
Byte buffer.


fInputStream

protected InputStream fInputStream
Deprecated. 
Input stream.


fOffset

protected int fOffset
Deprecated. 
Offset into buffer.

Constructor Detail

UTF8Reader

public UTF8Reader(InputStream inputStream)
Deprecated. 
Constructs a UTF-8 reader from the specified input stream using the default buffer size. Primarily for testing.


UTF8Reader

public UTF8Reader(InputStream inputStream,
                  int size,
                  MessageFormatter messageFormatter,
                  Locale locale)
Deprecated. 
Constructs a UTF-8 reader from the specified input stream, buffer size and MessageFormatter.


UTF8Reader

public UTF8Reader(InputStream inputStream,
                  MessageFormatter messageFormatter,
                  Locale locale)
Deprecated. 
Constructs a UTF-8 reader from the specified input stream using the default buffer size and the given MessageFormatter.

Method Detail

close

public void close()
           throws IOException
Deprecated. 
Close the stream. Once a stream has been closed, further read(), ready(), mark(), or reset() invocations will throw an IOException. Closing a previously-closed stream, however, has no effect.

Throws:
IOException - If an I/O error occurs

mark

public void mark(int readAheadLimit)
          throws IOException
Deprecated. 
Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point. Not all character-input streams support the mark() operation.

Parameters:
readAheadLimit - Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail.
Throws:
IOException - If the stream does not support mark(), or if some other I/O error occurs

markSupported

public boolean markSupported()
Deprecated. 
Tell whether this stream supports the mark() operation.


read

public int read()
         throws IOException
Deprecated. 
Read a single character. This method will block until a character is available, an I/O error occurs, or the end of the stream is reached.

Subclasses that intend to support efficient single-character input should override this method.

Returns:
The character read, as an integer in the range 0 to 16383 (0x00-0xffff), or -1 if the end of the stream has been reached
Throws:
IOException - If an I/O error occurs

read

public int read(char[] ch,
                int offset,
                int length)
         throws IOException
Deprecated. 
Read characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.

Parameters:
ch - Destination buffer
offset - Offset at which to start storing characters
length - Maximum number of characters to read
Returns:
The number of characters read, or -1 if the end of the stream has been reached
Throws:
IOException - If an I/O error occurs

ready

public boolean ready()
              throws IOException
Deprecated. 
Tell whether this stream is ready to be read.

Returns:
True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.
Throws:
IOException - If an I/O error occurs

reset

public void reset()
           throws IOException
Deprecated. 
Reset the stream. If the stream has been marked, then attempt to reposition it at the mark. If the stream has not been marked, then attempt to reset it in some way appropriate to the particular stream, for example by repositioning it to its starting point. Not all character-input streams support the reset() operation, and some support reset() without supporting mark().

Throws:
IOException - If the stream has not been marked, or if the mark has been invalidated, or if the stream does not support reset(), or if some other I/O error occurs

skip

public long skip(long n)
          throws IOException
Deprecated. 
Skip characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached.

Parameters:
n - The number of characters to skip
Returns:
The number of characters actually skipped
Throws:
IOException - If an I/O error occurs

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs91
Copyright 2005 BEA Systems Inc.