| java.lang.Object
 org.apache.xerces.impl.XMLEntityScanner
All known Subclasses: org.apache.xerces.impl.XML11EntityScanner,
| XMLEntityScanner | | public class XMLEntityScanner implements XMLLocator(Code) | | Implements the entity scanner methods.
author:
Andy Clark, IBM
author:
Neil Graham, IBM
version:
$Id: XMLEntityScanner.java 568411 2007-08-22 04:34:13Z mrglavas $ |
| Method Summary | |
| final public String | getBaseSystemId()
Returns the base system identifier of the currently scanned
entity, or null if none is available. | | final public int | getCharacterOffset()
Returns the character offset where the current document event ends. | | final public int | getColumnNumber()
Returns the column number where the current document event ends. | | final public String | getEncoding()
Returns the encoding of the current entity. | | final public String | getExpandedSystemId()
Return the expanded system identifier for the current document event. | | final public int | getLineNumber()
Returns the line number where the current document event ends. | | final public String | getLiteralSystemId()
Return the literal system identifier for the current document event. | | final public String | getPublicId()
Return the public identifier for the current document event. | | final public String | getXMLVersion()
Returns the XML version of the current entity. | | final public boolean | isExternal()
Returns true if the current entity being scanned is external. | | final boolean | load(int offset, boolean changeEntity)
Loads a chunk of text. | | public int | peekChar()
Returns the next character on the input. | | final public void | reset(SymbolTable symbolTable, XMLEntityManager entityManager, XMLErrorReporter reporter)
| | public int | scanChar()
Returns the next character on the input. | | public int | scanContent(XMLString content)
Scans a range of parsed character data, setting the fields of the
XMLString structure, appropriately.
Note: The characters are consumed.
Note: This method does not guarantee to return
the longest run of parsed character data. | | public boolean | scanData(String delimiter, XMLStringBuffer buffer)
Scans a range of character data up to the specified delimiter,
setting the fields of the XMLString structure, appropriately.
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. | | public int | scanLiteral(int quote, XMLString content)
Scans a range of attribute value data, setting the fields of the
XMLString structure, appropriately.
Note: The characters are consumed.
Note: This method does not guarantee to return
the longest run of attribute value data. | | public 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.
Note: The NCName characters are consumed.
Note: The string returned must be a symbol. | | public 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.
Note: The Name characters are consumed.
Note: The string returned must be a symbol. | | public 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.
Note: The NMTOKEN characters are consumed.
Note: The string returned must be a symbol. | | public boolean | scanQName(QName qname)
Scans a qualified name from the input, setting the fields of the
QName structure appropriately.
Note: The qualified name characters are consumed.
Note: The strings used to set the values of the
QName structure must be symbols. | | final public void | setBufferSize(int size)
| | final public void | setCurrentEntity(XMLEntityManager.ScannedEntity ent)
| | final public void | setEncoding(String encoding)
Sets the encoding of the scanner. | | final public void | setXMLVersion(String xmlVersion)
Sets the XML version. | | public boolean | skipChar(int c)
Skips a character appearing immediately on the input.
Note: The character is consumed only if it matches
the specified character.
Parameters:
c - The character to skip. | | final public 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. | | public boolean | skipSpaces()
Skips space characters appearing immediately on the input. | | public boolean | skipString(String s)
Skips the specified string appearing immediately on the input.
Note: The characters are consumed only if they are
space characters.
Parameters:
s - The string to skip. |
| fBufferSize | | protected int fBufferSize(Code) | | |
| fErrorReporter | | protected XMLErrorReporter fErrorReporter(Code) | | Error reporter. This property identifier is:
http://apache.org/xml/properties/internal/error-reporter
|
| XMLEntityScanner | | public XMLEntityScanner()(Code) | | Default constructor.
|
| getBaseSystemId | | final public String getBaseSystemId()(Code) | | Returns the base system identifier of the currently scanned
entity, or null if none is available.
|
| getCharacterOffset | | final public int getCharacterOffset()(Code) | | Returns the character offset where the current document event ends.
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.
The character offset, or -1 if none is available. |
| getColumnNumber | | final public int getColumnNumber()(Code) | | Returns the column number where the current document event ends.
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.
The column number, or -1 if none is available. |
| getEncoding | | final public String getEncoding()(Code) | | Returns the encoding of the current entity.
Note that, for a given entity, this value can only be
considered final once the encoding declaration has been read (or once it
has been determined that there is no such declaration) since, no encoding
having been specified on the XMLInputSource, the parser
will make an initial "guess" which could be in error.
|
| getExpandedSystemId | | final public String getExpandedSystemId()(Code) | | Return the expanded system identifier for the current document event.
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.
A string containing the expanded system identifier, or nullif none is available. |
| getLineNumber | | final public int getLineNumber()(Code) | | Returns the line number where the current document event ends.
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.
The line number, or -1 if none is available. |
| getLiteralSystemId | | final public String getLiteralSystemId()(Code) | | Return the literal system identifier for the current document event.
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.
A string containing the literal system identifier, or nullif none is available. |
| getPublicId | | final public String getPublicId()(Code) | | Return the public identifier for the current document event.
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.
A string containing the public identifier, ornull if none is available. |
| getXMLVersion | | final public String getXMLVersion()(Code) | | Returns the XML version of the current entity. This will normally be the
value from the XML or text declaration or defaulted by the parser. Note that
that this value may be different than the version of the processing rules
applied to the current entity. For instance, an XML 1.1 document may refer to
XML 1.0 entities. In such a case the rules of XML 1.1 are applied to the entire
document. Also note that, for a given entity, this value can only be considered
final once the XML or text declaration has been read or once it has been
determined that there is no such declaration.
|
| isExternal | | final public boolean isExternal()(Code) | | Returns true if the current entity being scanned is external.
|
| load | | final boolean load(int offset, boolean changeEntity) throws IOException(Code) | | Loads a chunk of text.
Parameters:
offset - The offset into the character buffer toread the next batch of characters.
Parameters:
changeEntity - True if the load should change entitiesat the end of the entity, otherwise leavethe current entity in place and the entityboundary will be signaled by the returnvalue. |
| peekChar | | public int peekChar() throws IOException(Code) | | Returns the next character on the input.
Note: The character is not consumed.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| scanChar | | public int scanChar() throws IOException(Code) | | Returns the next character on the input.
Note: The character is consumed.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| scanContent | | public int scanContent(XMLString content) throws IOException(Code) | | Scans a range of parsed character data, setting the fields of the
XMLString structure, appropriately.
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.
Parameters:
content - The content structure to fill. Returns the next character on the input, if known. Thisvalue may be -1 but this does note designateend of file.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| scanData | | public boolean scanData(String delimiter, XMLStringBuffer buffer) throws IOException(Code) | | Scans a range of character data up to the specified delimiter,
setting the fields of the XMLString structure, appropriately.
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.
Parameters:
delimiter - The string that signifies the end of the characterdata to be scanned.
Parameters:
buffer - The XMLStringBuffer to fill. Returns true if there is more data to scan, false otherwise.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| scanLiteral | | public int scanLiteral(int quote, XMLString content) throws IOException(Code) | | Scans a range of attribute value data, setting the fields of the
XMLString structure, appropriately.
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.
Parameters:
quote - The quote character that signifies the end of theattribute value data.
Parameters:
content - The content structure to fill. Returns the next character on the input, if known. Thisvalue may be -1 but this does note designateend of file.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| setBufferSize | | final public void setBufferSize(int size)(Code) | | |
| setEncoding | | final public void setEncoding(String encoding) throws IOException(Code) | | Sets the encoding of the scanner. This method is used by the
scanners if the XMLDecl or TextDecl line contains an encoding
pseudo-attribute.
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).
Parameters:
encoding - The IANA encoding name of the new encoding.
throws:
IOException - Thrown if the new encoding is not supported.
See Also: org.apache.xerces.util.EncodingMap |
| setXMLVersion | | final public void setXMLVersion(String xmlVersion)(Code) | | Sets the XML version. This method is used by the
scanners to report the value of the version pseudo-attribute
in an XML or text declaration.
Parameters:
xmlVersion - the XML version of the current entity |
| skipChar | | public boolean skipChar(int c) throws IOException(Code) | | Skips a character appearing immediately on the input.
Note: The character is consumed only if it matches
the specified character.
Parameters:
c - The character to skip. Returns true if the character was skipped.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| skipDeclSpaces | | final public boolean skipDeclSpaces() throws IOException(Code) | | 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. This is useful when scanning structures
such as the XMLDecl and TextDecl that can only contain US-ASCII
characters.
Note: The characters are consumed only if they would
match non-terminal S before end of line normalization is performed.
Returns true if at least one space character was skipped.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file.
See Also: org.apache.xerces.util.XMLChar.isSpace |
| skipSpaces | | public boolean skipSpaces() throws IOException(Code) | | Skips space characters appearing immediately on the input.
Note: The characters are consumed only if they are
space characters.
Returns true if at least one space character was skipped.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file.
See Also: org.apache.xerces.util.XMLChar.isSpace |
| skipString | | public boolean skipString(String s) throws IOException(Code) | | Skips the specified string appearing immediately on the input.
Note: The characters are consumed only if they are
space characters.
Parameters:
s - The string to skip. Returns true if the string was skipped.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
|
|