java.lang.Object | |
↳ | org.apache.xerces.impl.XMLEntityScanner |
Known Direct Subclasses |
Implements the entity scanner methods.@xerces.internal
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
fBufferSize | |||||||||||
fCurrentEntity | |||||||||||
fErrorReporter | Error reporter. | ||||||||||
fSymbolTable |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Default constructor.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the base system identifier of the currently scanned
entity, or null if none is available.
| |||||||||||
Returns the character offset where the current document event ends.
| |||||||||||
Returns the column number where the current document event ends.
| |||||||||||
Returns the encoding of the current entity.
| |||||||||||
Return the expanded system identifier for the current document event.
| |||||||||||
Returns the line number where the current document event ends.
| |||||||||||
Return the literal system identifier for the current document event.
| |||||||||||
Return the public identifier for the current document event.
| |||||||||||
Returns the XML version of the current entity.
| |||||||||||
Returns true if the current entity being scanned is external.
| |||||||||||
Returns the next character on the input.
| |||||||||||
Returns the next character on the input.
| |||||||||||
Scans a range of parsed character data, setting the fields of the
XMLString structure, appropriately.
| |||||||||||
Scans a range of character data up to the specified delimiter,
setting the fields of the XMLString structure, appropriately.
| |||||||||||
Scans a range of attribute value data, setting the fields of the
XMLString structure, appropriately.
| |||||||||||
Returns a string matching the NCName production appearing immediately
on the input as a symbol, or null if no NCName string is present.
| |||||||||||
Returns a string matching the Name production appearing immediately
on the input as a symbol, or null if no Name string is present.
| |||||||||||
Returns a string matching the NMTOKEN production appearing immediately
on the input as a symbol, or null if NMTOKEN Name string is present.
| |||||||||||
Scans a qualified name from the input, setting the fields of the
QName structure appropriately.
| |||||||||||
Sets the encoding of the scanner.
| |||||||||||
Sets the XML version.
| |||||||||||
Skips a character appearing immediately on the input.
| |||||||||||
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.
| |||||||||||
Skips space characters appearing immediately on the input.
| |||||||||||
Skips the specified string appearing immediately on the input.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.apache.xerces.xni.XMLLocator
|
Error reporter. This property identifier is: http://apache.org/xml/properties/internal/error-reporter
Default constructor.
Returns the base system identifier of the currently scanned entity, or null if none is available.
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.
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.
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.
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.
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.
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.
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.
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.
Returns true if the current entity being scanned is external.
Returns the next character on the input.
Note: The character is not consumed.
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
Returns the next character on the input.
Note: The character is consumed.
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
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.
content | The content structure to fill. |
---|
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
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.
delimiter | The string that signifies the end of the character data to be scanned. |
---|---|
buffer | The XMLStringBuffer to fill. |
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
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.
quote | The quote character that signifies the end of the attribute value data. |
---|---|
content | The content structure to fill. |
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
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. The SymbolTable can be used for this purpose.
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
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. The SymbolTable can be used for this purpose.
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
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. The SymbolTable can be used for this purpose.
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
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. The SymbolTable can be used for this purpose.
qname | The qualified name structure to fill. |
---|
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
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).
encoding | The IANA encoding name of the new encoding. |
---|
IOException | Thrown if the new encoding is not supported. |
---|
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.
xmlVersion | the XML version of the current entity |
---|
Skips a character appearing immediately on the input.
Note: The character is consumed only if it matches the specified character.
c | The character to skip. |
---|
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
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.
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
Skips space characters appearing immediately on the input.
Note: The characters are consumed only if they are space characters.
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |
Skips the specified string appearing immediately on the input.
Note: The characters are consumed only if they are space characters.
s | The string to skip. |
---|
IOException | Thrown if i/o error occurs. |
---|---|
EOFException | Thrown on end of file. |