FileDocCategorySizeDatePackage
ASCIIReader.javaAPI DocApache Xerces 3.0.19196Fri Sep 14 20:33:56 BST 2007org.apache.xerces.impl.io

ASCIIReader

public class ASCIIReader extends Reader
A simple ASCII byte reader. This is an optimized reader for reading byte streams that only contain 7-bit ASCII characters.
xerces.internal
author
Andy Clark, IBM
version
$Id: ASCIIReader.java 446716 2006-09-15 20:28:48Z mrglavas $

Fields Summary
public static final int
DEFAULT_BUFFER_SIZE
Default byte buffer size (2048).
protected final InputStream
fInputStream
Input stream.
protected final byte[]
fBuffer
Byte buffer.
private final org.apache.xerces.util.MessageFormatter
fFormatter
private final Locale
fLocale
Constructors Summary
public ASCIIReader(InputStream inputStream, org.apache.xerces.util.MessageFormatter messageFormatter, Locale locale)
Constructs an ASCII reader from the specified input stream using the default buffer size.

param
inputStream The input stream.
param
messageFormatter the MessageFormatter to use to message reporting.
param
locale the Locale for which messages are to be reported


    //
    // Constructors
    //

                                                      
        
              
        this(inputStream, DEFAULT_BUFFER_SIZE, messageFormatter, locale);
    
public ASCIIReader(InputStream inputStream, int size, org.apache.xerces.util.MessageFormatter messageFormatter, Locale locale)
Constructs an ASCII reader from the specified input stream and buffer size.

param
inputStream The input stream.
param
size The initial buffer size.
param
messageFormatter the MessageFormatter to use to message reporting.
param
locale the Locale for which messages are to be reported

        this(inputStream, new byte[size], messageFormatter, locale);
    
public ASCIIReader(InputStream inputStream, byte[] buffer, org.apache.xerces.util.MessageFormatter messageFormatter, Locale locale)
Constructs an ASCII reader from the specified input stream and buffer.

param
inputStream The input stream.
param
buffer The byte buffer.
param
messageFormatter the MessageFormatter to use to message reporting.
param
locale the Locale for which messages are to be reported

        fInputStream = inputStream;
        fBuffer = buffer;
        fFormatter = messageFormatter;
        fLocale = locale;
    
Methods Summary
public voidclose()
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.

exception
IOException If an I/O error occurs

         fInputStream.close();
     
public voidmark(int readAheadLimit)
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.

param
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.
exception
IOException If the stream does not support mark(), or if some other I/O error occurs

	    fInputStream.mark(readAheadLimit);
    
public booleanmarkSupported()
Tell whether this stream supports the mark() operation.

	    return fInputStream.markSupported();
    
public intread()
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.

return
The character read, as an integer in the range 0 to 127 (0x00-0x7f), or -1 if the end of the stream has been reached
exception
IOException If an I/O error occurs

        int b0 = fInputStream.read();
        if (b0 >= 0x80) {
            throw new MalformedByteSequenceException(fFormatter, 
                fLocale, XMLMessageFormatter.XML_DOMAIN, 
                "InvalidASCII", new Object [] {Integer.toString(b0)});
        }
        return b0;
    
public intread(char[] ch, int offset, int length)
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.

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

        if (length > fBuffer.length) {
            length = fBuffer.length;
        }
        int count = fInputStream.read(fBuffer, 0, length);
        for (int i = 0; i < count; i++) {
            int b0 = fBuffer[i];
            if (b0 < 0) {
                throw new MalformedByteSequenceException(fFormatter,
                    fLocale, XMLMessageFormatter.XML_DOMAIN,
                    "InvalidASCII", new Object [] {Integer.toString(b0 & 0x0FF)});
            }
            ch[offset + i] = (char)b0;
        }
        return count;
    
public booleanready()
Tell whether this stream is ready to be read.

return
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.
exception
IOException If an I/O error occurs

	    return false;
    
public voidreset()
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().

exception
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

        fInputStream.reset();
    
public longskip(long n)
Skip characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached.

param
n The number of characters to skip
return
The number of characters actually skipped
exception
IOException If an I/O error occurs

        return fInputStream.skip(n);