public class

XMLEntityScanner

extends Object
implements XMLLocator
java.lang.Object
   ↳ org.apache.xerces.impl.XMLEntityScanner
Known Direct Subclasses

Class Overview

Implements the entity scanner methods.@xerces.internal

Summary

Fields
protected int fBufferSize
protected XMLEntityManager.ScannedEntity fCurrentEntity
protected XMLErrorReporter fErrorReporter Error reporter.
protected SymbolTable fSymbolTable
Public Constructors
XMLEntityScanner()
Default constructor.
Public Methods
final String getBaseSystemId()
Returns the base system identifier of the currently scanned entity, or null if none is available.
final int getCharacterOffset()
Returns the character offset where the current document event ends.
final int getColumnNumber()
Returns the column number where the current document event ends.
final String getEncoding()
Returns the encoding of the current entity.
final String getExpandedSystemId()
Return the expanded system identifier for the current document event.
final int getLineNumber()
Returns the line number where the current document event ends.
final String getLiteralSystemId()
Return the literal system identifier for the current document event.
final String getPublicId()
Return the public identifier for the current document event.
final String getXMLVersion()
Returns the XML version of the current entity.
final boolean isExternal()
Returns true if the current entity being scanned is external.
int peekChar()
Returns the next character on the input.
final void reset(SymbolTable symbolTable, XMLEntityManager entityManager, XMLErrorReporter reporter)
int scanChar()
Returns the next character on the input.
int scanContent(XMLString content)
Scans a range of parsed character data, setting the fields of the XMLString structure, appropriately.
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.
int scanLiteral(int quote, XMLString content)
Scans a range of attribute value data, setting the fields of the XMLString structure, appropriately.
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.
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.
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(QName qname)
Scans a qualified name from the input, setting the fields of the QName structure appropriately.
final void setBufferSize(int size)
final void setCurrentEntity(XMLEntityManager.ScannedEntity ent)
final void setEncoding(String encoding)
Sets the encoding of the scanner.
final void setXMLVersion(String xmlVersion)
Sets the XML version.
boolean skipChar(int c)
Skips a character appearing immediately on the input.
final 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(String s)
Skips the specified string appearing immediately on the input.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.xerces.xni.XMLLocator

Fields

protected int fBufferSize

protected XMLEntityManager.ScannedEntity fCurrentEntity

protected XMLErrorReporter fErrorReporter

Error reporter. This property identifier is: http://apache.org/xml/properties/internal/error-reporter

protected SymbolTable fSymbolTable

Public Constructors

public XMLEntityScanner ()

Default constructor.

Public Methods

public final String getBaseSystemId ()

Returns the base system identifier of the currently scanned entity, or null if none is available.

public final int getCharacterOffset ()

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 character offset, or -1 if none is available.

public final int getColumnNumber ()

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 column number, or -1 if none is available.

public final String getEncoding ()

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.

public final String getExpandedSystemId ()

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
  • A string containing the expanded system identifier, or null if none is available.

public final int getLineNumber ()

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.

Returns
  • The line number, or -1 if none is available.

public final String getLiteralSystemId ()

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.

Returns
  • A string containing the literal system identifier, or null if none is available.

public final String getPublicId ()

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
  • A string containing the public identifier, or null if none is available.

public final String getXMLVersion ()

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.

public final boolean isExternal ()

Returns true if the current entity being scanned is external.

public int peekChar ()

Returns the next character on the input.

Note: The character is not consumed.

Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

public final void reset (SymbolTable symbolTable, XMLEntityManager entityManager, XMLErrorReporter reporter)

public int scanChar ()

Returns the next character on the input.

Note: The character is consumed.

Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

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. 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
  • Returns the next character on the input, if known. This value may be -1 but this does note designate end of file.
Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

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. 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 character data to be scanned.
buffer The XMLStringBuffer to fill.
Returns
  • Returns true if there is more data to scan, false otherwise.
Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

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. 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 the attribute value data.
content The content structure to fill.
Returns
  • Returns the next character on the input, if known. This value may be -1 but this does note designate end of file.
Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

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. The SymbolTable can be used for this purpose.

Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

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. The SymbolTable can be used for this purpose.

Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

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. The SymbolTable can be used for this purpose.

Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

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. The SymbolTable can be used for this purpose.

Parameters
qname The qualified name structure to fill.
Returns
  • Returns true if a qualified name appeared immediately on the input and was scanned, false otherwise.
Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

public final void setBufferSize (int size)

public final void setCurrentEntity (XMLEntityManager.ScannedEntity ent)

public final void setEncoding (String encoding)

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

public final void setXMLVersion (String xmlVersion)

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

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.
Returns
  • Returns true if the character was skipped.
Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.

public final 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. 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
  • Returns true if at least one space character was skipped.
Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.
See Also

public boolean skipSpaces ()

Skips space characters appearing immediately on the input.

Note: The characters are consumed only if they are space characters.

Returns
  • Returns true if at least one space character was skipped.
Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.
See Also

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.
Returns
  • Returns true if the string was skipped.
Throws
IOException Thrown if i/o error occurs.
EOFException Thrown on end of file.