public class XML11EntityScanner extends XMLEntityScanner
fBufferSize, fCurrentEntity, fErrorReporter, fSymbolTable
Constructor and Description |
---|
XML11EntityScanner()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
int |
peekChar()
Returns the next character on the input.
|
int |
scanChar()
Returns the next character on the input.
|
int |
scanContent(org.apache.xerces.xni.XMLString content)
Scans a range of parsed character data, setting the fields of the
XMLString structure, appropriately.
|
boolean |
scanData(java.lang.String delimiter,
XMLStringBuffer buffer)
Scans a range of character data up to the specicied delimiter,
setting the fields of the XMLString structure, appropriately.
|
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.
|
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.
|
java.lang.String |
scanNCName()
Returns a string matching the NCName production appearing immediately
on the input as a symbol, or null if no NCName string is present.
|
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.
|
boolean |
scanQName(org.apache.xerces.xni.QName qname)
Scans a qualified name from the input, setting the fields of the
QName structure appropriately.
|
boolean |
skipChar(int c)
Skips a character appearing immediately on the input.
|
boolean |
skipSpaces()
Skips space characters appearing immediately on the input.
|
boolean |
skipString(java.lang.String s)
Skips the specified string appearing immediately on the input.
|
getBaseSystemId, getCharacterOffset, getColumnNumber, getEncoding, getExpandedSystemId, getLineNumber, getLiteralSystemId, getPublicId, getXMLVersion, isExternal, reset, setBufferSize, setCurrentEntity, setEncoding, setXMLVersion, skipDeclSpaces
public int peekChar() throws java.io.IOException
Note: The character is not consumed.
peekChar
in class XMLEntityScanner
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.public int scanChar() throws java.io.IOException
Note: The character is consumed.
scanChar
in class XMLEntityScanner
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.public 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.
scanNmtoken
in class XMLEntityScanner
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.SymbolTable
,
XML11Char.isXML11Name(int)
public 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.
scanName
in class XMLEntityScanner
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.SymbolTable
,
XML11Char.isXML11Name(int)
,
XML11Char.isXML11NameStart(int)
public java.lang.String scanNCName() throws java.io.IOException
Note: The NCName characters are consumed.
Note: The string returned must be a symbol. The SymbolTable can be used for this purpose.
scanNCName
in class XMLEntityScanner
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.SymbolTable
,
XML11Char.isXML11NCName(int)
,
XML11Char.isXML11NCNameStart(int)
public 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.
scanQName
in class XMLEntityScanner
qname
- The qualified name structure to fill.java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.SymbolTable
,
XML11Char.isXML11Name(int)
,
XML11Char.isXML11NameStart(int)
public 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.
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.
scanContent
in class XMLEntityScanner
content
- The content structure to fill.java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.public 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.
scanLiteral
in class XMLEntityScanner
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.java.io.EOFException
- Thrown on end of file.public boolean scanData(java.lang.String delimiter, XMLStringBuffer buffer) 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.
scanData
in class XMLEntityScanner
delimiter
- The string that signifies the end of the character
data to be scanned.buffer
- The XMLStringBuffer to fill.java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.public boolean skipChar(int c) throws java.io.IOException
Note: The character is consumed only if it matches the specified character.
skipChar
in class XMLEntityScanner
c
- The character to skip.java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.public boolean skipSpaces() throws java.io.IOException
Note: The characters are consumed only if they are space characters.
skipSpaces
in class XMLEntityScanner
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.XMLChar.isSpace(int)
,
XML11Char.isXML11Space(int)
public boolean skipString(java.lang.String s) throws java.io.IOException
Note: The characters are consumed only if they are space characters.
skipString
in class XMLEntityScanner
s
- The string to skip.java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.Copyright © 1999-2022 The Apache Software Foundation. All Rights Reserved.