org.enhydra.apache.xerces.readers
Class StringReader

java.lang.Object
  |
  +--org.enhydra.apache.xerces.readers.XMLEntityReader
        |
        +--org.enhydra.apache.xerces.readers.StringReader
All Implemented Interfaces:
XMLEntityHandler.EntityReader

final class StringReader
extends XMLEntityReader

Reader for processing internal entity replacement text.

This reader processes data contained within strings kept in the string pool. It provides the support for both general and parameter entities. The location support as we are processing the replacement text is somewhat poor and needs to be updated when "nested locations" have been implemented.

For efficiency, we return instances of this class to a free list and reuse those instances to process other strings.

Version:
$id$

Field Summary
protected  int fCarriageReturnCounter
           
protected  int fCharacterCounter
           
protected  XMLEntityHandler.CharDataHandler fCharDataHandler
           
protected  int fCurrentOffset
           
protected  XMLEntityHandler fEntityHandler
           
protected  XMLErrorReporter fErrorReporter
           
static byte[] fgAsciiEntityValueChar
           
protected  boolean fInCDSect
           
protected  int fLinefeedCounter
           
protected  boolean fSendCharDataAsCharArray
           
 
Method Summary
 int addString(int offset, int length)
          Add a string to the StringPool from the characters scanned using this reader as described by offset and length.
 int addSymbol(int offset, int length)
          Add a symbol to the StringPool from the characters scanned using this reader as described by offset and length.
 void append(XMLEntityHandler.CharBuffer charBuffer, int offset, int length)
          Append the characters processed by this reader associated with offset and length to the CharBuffer.
 XMLEntityHandler.EntityReader changeReaders()
          This method is called by the reader subclasses at the end of input.
static StringReader createStringReader(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, boolean sendCharDataAsCharArray, int lineNumber, int columnNumber, int stringHandle, StringPool stringPool, boolean addEnclosingSpaces)
          Allocate a string reader
 int currentOffset()
          Return the current offset within this reader.
 int getColumnNumber()
          Return the column number of the current position within the document that we are processing.
 boolean getInCDSect()
          This method is provided for scanner implementations.
 int getLineNumber()
          Return the line number of the current position within the document that we are processing.
protected  void init(XMLEntityHandler entityHandler, XMLErrorReporter errorReporter, boolean sendCharDataAsCharArray, int lineNumber, int columnNumber)
           
 boolean lookingAtChar(char chr, boolean skipPastChar)
          Test that the current character is a ch character.
 boolean lookingAtSpace(boolean skipPastChar)
          Test that the current character is a whitespace character.
 boolean lookingAtValidChar(boolean skipPastChar)
          Test that the current character is valid.
 int scanAttValue(char qchar, boolean asSymbol)
          Scan an attribute value.
 int scanCharRef(boolean hex)
          Scan a character reference.
 int scanContent(QName element)
          Skip through the input while we are looking at character data.
 int scanEntityValue(int qchar, boolean createString)
          Scan an entity value.
 boolean scanExpectedName(char fastcheck, StringPool.CharArrayRange expectedName)
          Scan the name that is expected at the current position in the document.
 int scanInvalidChar()
          Scan an invalid character.
 int scanName(char fastcheck)
          Add a sequence of characters that match the XML definition of a Name to the StringPool.
 void scanQName(char fastcheck, QName qname)
          Add a sequence of characters that match the XML Namespaces definition of a QName to the StringPool.
 int scanStringLiteral()
          Scan a string literal.
 void setInCDSect(boolean inCDSect)
          This method is provided for scanner implementations.
 void skipPastName(char fastcheck)
          Skip past a sequence of characters that match the XML definition of a Name.
 void skipPastNmtoken(char fastcheck)
          Skip past a sequence of characters that match the XML definition of an Nmtoken.
 void skipPastSpaces()
          Skip past whitespace characters starting at the current position.
 boolean skippedString(char[] s)
          Skip past a sequence of characters that matches the specified character array.
 void skipToChar(char chr)
          Advance through the input data up to the next ch character.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fgAsciiEntityValueChar

public static final byte[] fgAsciiEntityValueChar

fEntityHandler

protected XMLEntityHandler fEntityHandler

fErrorReporter

protected XMLErrorReporter fErrorReporter

fSendCharDataAsCharArray

protected boolean fSendCharDataAsCharArray

fCharDataHandler

protected XMLEntityHandler.CharDataHandler fCharDataHandler

fInCDSect

protected boolean fInCDSect

fCarriageReturnCounter

protected int fCarriageReturnCounter

fLinefeedCounter

protected int fLinefeedCounter

fCharacterCounter

protected int fCharacterCounter

fCurrentOffset

protected int fCurrentOffset
Method Detail

createStringReader

public static StringReader createStringReader(XMLEntityHandler entityHandler,
                                              XMLErrorReporter errorReporter,
                                              boolean sendCharDataAsCharArray,
                                              int lineNumber,
                                              int columnNumber,
                                              int stringHandle,
                                              StringPool stringPool,
                                              boolean addEnclosingSpaces)
Allocate a string reader

Parameters:
entityHandler - The current entity handler.
errorReporter - The current error reporter.
sendCharDataAsCharArray - true if char data should be reported using char arrays instead of string handles.
lineNumber - The line number to return as our position.
columnNumber - The column number to return as our position.
stringHandle - The StringPool handle for the data to process.
stringPool - The string pool.
addEnclosingSpaces - If true, treat the data to process as if there were a leading and trailing space character enclosing the string data.
Returns:
The reader that will process the string data.

addString

public int addString(int offset,
                     int length)
Description copied from interface: XMLEntityHandler.EntityReader
Add a string to the StringPool from the characters scanned using this reader as described by offset and length.

Parameters:
offset - The offset within this reader where the characters start.
length - The length within this reader where the characters end.
Returns:
The StringPool handle for the string.

addSymbol

public int addSymbol(int offset,
                     int length)
Description copied from interface: XMLEntityHandler.EntityReader
Add a symbol to the StringPool from the characters scanned using this reader as described by offset and length.

Parameters:
offset - The offset within this reader where the characters start.
length - The length within this reader where the characters end.
Returns:
The StringPool handle for the symbol.

append

public void append(XMLEntityHandler.CharBuffer charBuffer,
                   int offset,
                   int length)
Description copied from interface: XMLEntityHandler.EntityReader
Append the characters processed by this reader associated with offset and length to the CharBuffer.

Parameters:
charBuffer - The CharBuffer to append the characters to.
offset - The offset within this reader where the copy should start.
length - The length within this reader where the copy should stop.

changeReaders

public XMLEntityHandler.EntityReader changeReaders()
                                            throws Exception
Description copied from class: XMLEntityReader
This method is called by the reader subclasses at the end of input.

Overrides:
changeReaders in class XMLEntityReader
Exception

lookingAtChar

public boolean lookingAtChar(char chr,
                             boolean skipPastChar)
                      throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Test that the current character is a ch character.

Parameters:
chr - The character to match against.
skipPastChar - If true, we advance past the matched character.
Returns:
true if the current character is a ch character; false otherwise.
Throws:
Exception

lookingAtValidChar

public boolean lookingAtValidChar(boolean skipPastChar)
                           throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Test that the current character is valid.

Parameters:
skipPastChar - If true, we advance past the valid character.
Returns:
true if the current character is valid; false otherwise.
Throws:
Exception

lookingAtSpace

public boolean lookingAtSpace(boolean skipPastChar)
                       throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Test that the current character is a whitespace character.

Parameters:
skipPastChar - If true, we advance past the whitespace character.
Returns:
true if the current character is whitespace; false otherwise.
Throws:
Exception

skipToChar

public void skipToChar(char chr)
                throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Advance through the input data up to the next ch character.

Parameters:
chr - The character to search for.
Throws:
Exception

skipPastSpaces

public void skipPastSpaces()
                    throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Skip past whitespace characters starting at the current position.

Throws:
Exception

skipPastName

public void skipPastName(char fastcheck)
                  throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Skip past a sequence of characters that match the XML definition of a Name.

Throws:
Exception

skipPastNmtoken

public void skipPastNmtoken(char fastcheck)
                     throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Skip past a sequence of characters that match the XML definition of an Nmtoken.

Throws:
Exception

skippedString

public boolean skippedString(char[] s)
                      throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Skip past a sequence of characters that matches the specified character array.

Parameters:
s - The characters to match.
Returns:
true if the current character is valid; false otherwise.
Throws:
Exception

scanInvalidChar

public int scanInvalidChar()
                    throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Scan an invalid character.

Returns:
The invalid character as an integer, or -1 if there was a bad encoding.
Throws:
Exception

scanCharRef

public int scanCharRef(boolean hex)
                throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Scan a character reference.

Returns:
The value of the character, or one of the following error codes: CHARREF_RESULT_SEMICOLON_REQUIRED CHARREF_RESULT_INVALID_CHAR CHARREF_RESULT_OUT_OF_RANGE
Throws:
Exception

scanStringLiteral

public int scanStringLiteral()
                      throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Scan a string literal.

Returns:
The StringPool handle for the string that was scanned, or one of the following error codes: STRINGLIT_RESULT_QUOTE_REQUIRED STRINGLIT_RESULT_INVALID_CHAR
Throws:
Exception

scanAttValue

public int scanAttValue(char qchar,
                        boolean asSymbol)
                 throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Scan an attribute value.

Parameters:
qchar - The initial quote character, either a single or double quote.
Returns:
The StringPool handle for the string that was scanned, or one of the following error codes: ATTVALUE_RESULT_COMPLEX ATTVALUE_RESULT_LESSTHAN ATTVALUE_RESULT_INVALID_CHAR
Throws:
Exception

scanEntityValue

public int scanEntityValue(int qchar,
                           boolean createString)
                    throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Scan an entity value.

Parameters:
qchar - The initial quote character, either a single or double quote.
Returns:
The StringPool handle for the string that was scanned, or one of the following error codes: ENTITYVALUE_RESULT_FINISHED ENTITYVALUE_RESULT_REFERENCE ENTITYVALUE_RESULT_PEREF ENTITYVALUE_RESULT_INVALID_CHAR ENTITYVALUE_RESULT_END_OF_INPUT
Throws:
Exception

scanExpectedName

public boolean scanExpectedName(char fastcheck,
                                StringPool.CharArrayRange expectedName)
                         throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Scan the name that is expected at the current position in the document. This method is invoked when we are scanning the element type in an end tag that must match the element type in the corresponding start tag.

Parameters:
fastcheck - A character that is not a legal name character that is provided as a hint to the reader of a character likely to terminate the Name.
expectedName - The characters of the name we expect.
Returns:
true if we scanned the name we expected to find; otherwise false if we did not.
Throws:
Exception

scanQName

public void scanQName(char fastcheck,
                      QName qname)
               throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Add a sequence of characters that match the XML Namespaces definition of a QName to the StringPool. If we find a QName at the current position we will add it to the StringPool and will return the string pool handle of that QName to the caller.

Parameters:
fastcheck - A character that is not a legal name character that is provided as a hint to the reader of a character likely to terminate the Name.
Throws:
Exception

scanName

public int scanName(char fastcheck)
             throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Add a sequence of characters that match the XML definition of a Name to the StringPool. If we find a name at the current position we will add it to the StringPool as a symbol and will return the string pool handle for that symbol to the caller.

Parameters:
fastcheck - A character that is not a legal name character that is provided as a hint to the reader of a character likely to terminate the Name.
Returns:
The StringPool handle for the name that was scanned, or -1 if a name was not found at the current position within the input data.
Throws:
Exception

scanContent

public int scanContent(QName element)
                throws Exception
Description copied from interface: XMLEntityHandler.EntityReader
Skip through the input while we are looking at character data.

Returns:
One of the following result codes: CONTENT_RESULT_START_OF_PI CONTENT_RESULT_START_OF_COMMENT CONTENT_RESULT_START_OF_CDSECT CONTENT_RESULT_END_OF_CDSECT CONTENT_RESULT_START_OF_ETAG CONTENT_RESULT_MATCHING_ETAG CONTENT_RESULT_START_OF_ELEMENT CONTENT_RESULT_START_OF_CHARREF CONTENT_RESULT_START_OF_ENTITYREF CONTENT_RESULT_INVALID_CHAR CONTENT_RESULT_MARKUP_NOT_RECOGNIZED CONTENT_RESULT_MARKUP_END_OF_INPUT CONTENT_RESULT_REFERENCE_END_OF_INPUT
Throws:
Exception

init

protected void init(XMLEntityHandler entityHandler,
                    XMLErrorReporter errorReporter,
                    boolean sendCharDataAsCharArray,
                    int lineNumber,
                    int columnNumber)

currentOffset

public int currentOffset()
Return the current offset within this reader.

Specified by:
currentOffset in interface XMLEntityHandler.EntityReader
Returns:
The offset.

getLineNumber

public int getLineNumber()
Return the line number of the current position within the document that we are processing.

Specified by:
getLineNumber in interface XMLEntityHandler.EntityReader
Returns:
The current line number.

getColumnNumber

public int getColumnNumber()
Return the column number of the current position within the document that we are processing.

Specified by:
getColumnNumber in interface XMLEntityHandler.EntityReader
Returns:
The current column number.

setInCDSect

public void setInCDSect(boolean inCDSect)
This method is provided for scanner implementations.

Specified by:
setInCDSect in interface XMLEntityHandler.EntityReader

getInCDSect

public boolean getInCDSect()
This method is provided for scanner implementations.

Specified by:
getInCDSect in interface XMLEntityHandler.EntityReader


Copyright © 1999 The Apache Software Foundation. All Rights reserved.