public class XMLEntityScanner
extends java.lang.Object
implements org.apache.xerces.xni.XMLLocator
Modifier and Type | Field and Description |
---|---|
protected int |
fBufferSize |
protected XMLEntityManager.ScannedEntity |
fCurrentEntity |
protected XMLErrorReporter |
fErrorReporter
Error reporter.
|
protected SymbolTable |
fSymbolTable |
Constructor and Description |
---|
XMLEntityScanner()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBaseSystemId()
Returns the base system identifier of the currently scanned
entity, or null if none is available.
|
int |
getCharacterOffset()
Returns the character offset where the current document event ends.
|
int |
getColumnNumber()
Returns the column number where the current document event ends.
|
java.lang.String |
getEncoding()
Returns the encoding of the current entity.
|
java.lang.String |
getExpandedSystemId()
Return the expanded system identifier for the current document event.
|
int |
getLineNumber()
Returns the line number where the current document event ends.
|
java.lang.String |
getLiteralSystemId()
Return the literal system identifier for the current document event.
|
java.lang.String |
getPublicId()
Return the public identifier for the current document event.
|
java.lang.String |
getXMLVersion()
Returns the XML version of the current entity.
|
boolean |
isExternal()
Returns true if the current entity being scanned is external.
|
int |
peekChar()
Returns the next character on the input.
|
void |
reset(SymbolTable symbolTable,
XMLEntityManager entityManager,
XMLErrorReporter reporter) |
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 specified 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.
|
void |
setBufferSize(int size) |
void |
setCurrentEntity(XMLEntityManager.ScannedEntity ent) |
void |
setEncoding(java.lang.String encoding)
Sets the encoding of the scanner.
|
void |
setXMLVersion(java.lang.String xmlVersion)
Sets the XML version.
|
boolean |
skipChar(int c)
Skips a character appearing immediately on the input.
|
boolean |
skipDeclSpaces()
Skips space characters appearing immediately on the input that would
match non-terminal S (0x09, 0x0A, 0x0D, 0x20) before end of line
normalization is performed.
|
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.
|
protected XMLEntityManager.ScannedEntity fCurrentEntity
protected SymbolTable fSymbolTable
protected int fBufferSize
protected XMLErrorReporter fErrorReporter
public final java.lang.String getBaseSystemId()
getBaseSystemId
in interface org.apache.xerces.xni.XMLLocator
public final 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
public final void setXMLVersion(java.lang.String xmlVersion)
xmlVersion
- the XML version of the current entitypublic final boolean isExternal()
public int peekChar() throws java.io.IOException
Note: The character is not consumed.
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.
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.
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.SymbolTable
,
XMLChar.isName(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.
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.SymbolTable
,
XMLChar.isName(int)
,
XMLChar.isNameStart(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.
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.SymbolTable
,
XMLChar.isNCName(int)
,
XMLChar.isNCNameStart(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.
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
,
XMLChar.isName(int)
,
XMLChar.isNameStart(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.
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.
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.
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.
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.
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.XMLChar.isSpace(int)
public final boolean skipDeclSpaces() throws java.io.IOException
Note: The characters are consumed only if they would match non-terminal S before end of line normalization is performed.
java.io.IOException
- Thrown if i/o error occurs.java.io.EOFException
- Thrown on end of file.XMLChar.isSpace(int)
public 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.java.io.EOFException
- Thrown on end of file.public final java.lang.String getPublicId()
The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.
getPublicId
in interface org.apache.xerces.xni.XMLLocator
public final java.lang.String getExpandedSystemId()
The return value is the expanded system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.
If the system identifier is a URL, the parser must resolve it fully before passing it to the application.
getExpandedSystemId
in interface org.apache.xerces.xni.XMLLocator
public final java.lang.String getLiteralSystemId()
The return value is the literal system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.
getLiteralSystemId
in interface org.apache.xerces.xni.XMLLocator
public final int getLineNumber()
Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears.
If possible, the line position of the first character after the text associated with the document event should be provided. The first line in the document is line 1.
getLineNumber
in interface org.apache.xerces.xni.XMLLocator
public final int getColumnNumber()
Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears.
If possible, the line position of the first character after the text associated with the document event should be provided. The first column in each line is column 1.
getColumnNumber
in interface org.apache.xerces.xni.XMLLocator
public final int getCharacterOffset()
Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
The return value is an approximation of the character offset in the document entity or external parsed entity where the markup triggering the event appears.
If possible, the character offset of the first character after the text associated with the document event should be provided.
getCharacterOffset
in interface org.apache.xerces.xni.XMLLocator
public final java.lang.String getEncoding()
getEncoding
in interface org.apache.xerces.xni.XMLLocator
public final java.lang.String getXMLVersion()
getXMLVersion
in interface org.apache.xerces.xni.XMLLocator
public final void setCurrentEntity(XMLEntityManager.ScannedEntity ent)
public final void setBufferSize(int size)
public final void reset(SymbolTable symbolTable, XMLEntityManager entityManager, XMLErrorReporter reporter)
Copyright © 1999-2022 The Apache Software Foundation. All Rights Reserved.