com.sun.xml.stream
public abstract class XMLEntityReader extends java.lang.Object implements org.apache.xerces.xni.XMLLocator
There is only one entity scanner and entity manager per parser. The entity manager could implement the methods to perform entity scanning, but the entity scanner class allows a cleaner separation between entity management API and entity scanning.
XMLEntityHandler
,
XMLEntityManager
Constructor and Description |
---|
XMLEntityReader() |
Modifier and Type | Method and Description |
---|---|
abstract int |
getCharacterOffset() |
abstract java.lang.String |
getEncoding() |
abstract java.lang.String |
getVersion()
get the version of the entity on which reader is operating
|
abstract boolean |
isExternal()
Returns true if the current entity being scanned is external.
|
abstract int |
peekChar()
Returns the next character on the input.
|
abstract void |
registerListener(XMLBufferListener listener) |
abstract int |
scanChar()
Returns the next character on the input.
|
abstract int |
scanContent(org.apache.xerces.xni.XMLString content)
CHANGED:
Scans a range of parsed character data, This function appends the character data to
the supplied buffer.
|
abstract boolean |
scanData(java.lang.String delimiter,
org.apache.xerces.util.XMLStringBuffer data)
Scans a range of character data up to the specicied delimiter,
setting the fields of the XMLString structure, appropriately.
|
abstract int |
scanLiteral(int quote,
org.apache.xerces.xni.XMLString content)
Scans a range of attribute value data, setting the fields of the
XMLString structure, appropriately.
|
abstract java.lang.String |
scanName()
Returns a string matching the Name production appearing immediately
on the input as a symbol, or null if no Name string is present.
|
abstract java.lang.String |
scanNmtoken()
Returns a string matching the NMTOKEN production appearing immediately
on the input as a symbol, or null if NMTOKEN Name string is present.
|
abstract boolean |
scanQName(org.apache.xerces.xni.QName qname)
Scans a qualified name from the input, setting the fields of the
QName structure appropriately.
|
abstract void |
setEncoding(java.lang.String encoding)
Sets the encoding of the scanner.
|
abstract void |
setVersion(java.lang.String version)
the version of the current entity being scanned or the version of the entity on which reader is operating
|
abstract boolean |
skipChar(int c)
Skips a character appearing immediately on the input.
|
abstract boolean |
skipSpaces()
Skips space characters appearing immediately on the input.
|
abstract boolean |
skipString(java.lang.String s)
Skips the specified string appearing immediately on the input.
|
public abstract void setEncoding(java.lang.String encoding) throws java.io.IOException
Note: The underlying character reader on the current entity will be changed to accomodate the new encoding. However, the new encoding is ignored if the current reader was not constructed from an input stream (e.g. an external entity that is resolved directly to the appropriate java.io.Reader object).
encoding
- The IANA encoding name of the new encoding.java.io.IOException
- Thrown if the new encoding is not supported.EncodingMap
,
XMLChar.isValidIANAEncoding(java.lang.String)
,
XMLChar.isValidJavaEncoding(java.lang.String)
public abstract java.lang.String getEncoding()
getEncoding
in interface org.apache.xerces.xni.XMLLocator
public abstract int getCharacterOffset()
getCharacterOffset
in interface org.apache.xerces.xni.XMLLocator
public abstract void setVersion(java.lang.String version)
public abstract java.lang.String getVersion()
public abstract boolean isExternal()
public abstract int peekChar() throws java.io.IOException
Note: The character is not consumed.
java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.public abstract int scanChar() throws java.io.IOException
Note: The character is consumed.
java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.public abstract java.lang.String scanNmtoken() throws java.io.IOException
Note: The NMTOKEN characters are consumed.
Note: The string returned must be a symbol. The SymbolTable can be used for this purpose.
java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.SymbolTable
,
XMLChar.isName(int)
public abstract java.lang.String scanName() throws java.io.IOException
Note: The Name characters are consumed.
Note: The string returned must be a symbol. The SymbolTable can be used for this purpose.
java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.SymbolTable
,
XMLChar.isName(int)
,
XMLChar.isNameStart(int)
public abstract boolean scanQName(org.apache.xerces.xni.QName qname) throws java.io.IOException
Note: The qualified name characters are consumed.
Note: The strings used to set the values of the QName structure must be symbols. The SymbolTable can be used for this purpose.
qname
- The qualified name structure to fill.java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.SymbolTable
,
XMLChar.isName(int)
,
XMLChar.isNameStart(int)
public abstract int scanContent(org.apache.xerces.xni.XMLString content) throws java.io.IOException
Note: The characters are consumed.
Note: This method does not guarantee to return the longest run of parsed character data. This method may return before markup due to reaching the end of the input buffer or any other reason.
content
- The content structure to fill.java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.public abstract int scanLiteral(int quote, org.apache.xerces.xni.XMLString content) throws java.io.IOException
Note: The characters are consumed.
Note: This method does not guarantee to return the longest run of attribute value data. This method may return before the quote character due to reaching the end of the input buffer or any other reason.
Note: The fields contained in the XMLString structure are not guaranteed to remain valid upon subsequent calls to the entity scanner. Therefore, the caller is responsible for immediately using the returned character data or making a copy of the character data.
quote
- The quote character that signifies the end of the
attribute value data.content
- The content structure to fill.java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.public abstract boolean scanData(java.lang.String delimiter, org.apache.xerces.util.XMLStringBuffer data) throws java.io.IOException
Note: The characters are consumed.
Note: This assumes that the internal buffer is at least the same size, or bigger, than the length of the delimiter and that the delimiter contains at least one character.
Note: This method does not guarantee to return the longest run of character data. This method may return before the delimiter due to reaching the end of the input buffer or any other reason.
Note: The fields contained in the XMLString structure are not guaranteed to remain valid upon subsequent calls to the entity scanner. Therefore, the caller is responsible for immediately using the returned character data or making a copy of the character data.
delimiter
- The string that signifies the end of the character
data to be scanned.data
- The data structure to fill.java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.public abstract boolean skipChar(int c) throws java.io.IOException
Note: The character is consumed only if it matches the specified character.
c
- The character to skip.java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.public abstract boolean skipSpaces() throws java.io.IOException
Note: The characters are consumed only if they are space characters.
java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.XMLChar.isSpace(int)
public abstract boolean skipString(java.lang.String s) throws java.io.IOException
Note: The characters are consumed only if they are space characters.
s
- The string to skip.java.io.IOException
- Thrown if i/o error occurs.EOFException
- Thrown on end of file.public abstract void registerListener(XMLBufferListener listener)
Copyright ? 2002-2003 Apache XML Project. All Rights Reserved.