jdk7u.jaxp.org.apache.xerces.external.impl

Class XMLEntityScanner

java.lang.Object

jdk7u.jaxp.org.apache.xerces.external.impl.XMLEntityScanner

All Implemented Interfaces:

XMLLocator

Direct Known Subclasses:

XML11EntityScanner

public class XMLEntityScanner
extends Object
implements XMLLocator

Implements the entity scanner methods.

Author:

Neeraj Bajaj, Sun Microsystems, Andy Clark, IBM, Arnaud Le Hors, IBM, K.Venugopal Sun Microsystems

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALLOW_JAVA_ENCODINGS Feature identifier: allow Java encodings.
protected static String	ERROR_REPORTER Property identifier: error reporter.
protected boolean	fAllowJavaEncodings Allow Java encoding names.
protected int	fBufferSize
protected Entity.ScannedEntity	fCurrentEntity
protected XMLEntityManager	fEntityManager
protected XMLErrorReporter	fErrorReporter
protected PropertyManager	fPropertyManager
protected SymbolTable	fSymbolTable
protected static String	SYMBOL_TABLE Property identifier: symbol table.

Constructor Summary

Constructors

Constructor and Description
XMLEntityScanner() Default constructor.
XMLEntityScanner(PropertyManager propertyManager, XMLEntityManager entityManager) private constructor, this class can only be instantiated within this class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	arrangeCapacity(int length)
boolean	arrangeCapacity(int length, boolean changeEntity)
protected Reader	createReader(InputStream inputStream, String encoding, Boolean isBigEndian) Creates a reader capable of reading the given input stream in the specified encoding.
String	getBaseSystemId() Returns the base system identifier of the currently scanned entity, or null if none is available.
int	getChar(int relative)
int	getCharacterOffset() Returns the character offset, or -1 if no character offset is available.
int	getColumnNumber() Returns the column number, or -1 if no column number is available.
Entity.ScannedEntity	getCurrentEntity()
String	getEncoding() Returns the encoding of the current entity.
protected Object[]	getEncodingName(byte[] b4, int count) Returns the IANA encoding name that is auto-detected from the bytes specified, with the endian-ness of that encoding where appropriate.
String	getExpandedSystemId() Returns the expanded system identifier.
int	getLineNumber() Returns the line number, or -1 if no line number is available.
String	getLiteralSystemId() Returns the literal system identifier.
String	getPublicId() Returns the public identifier.
String	getVersion()
String	getXMLVersion() Returns the XML version of the current entity.
boolean	isExternal() Returns true if the current entity being scanned is external.
boolean	isSpace(char ch)
int	peekChar() Returns the next character on the input.
void	registerListener(XMLBufferListener listener) Registers the listener object and provides callback.
void	reset(PropertyManager propertyManager) Resets the components.
void	reset(SymbolTable symbolTable, XMLEntityManager entityManager, XMLErrorReporter reporter)
void	reset(XMLComponentManager componentManager) Resets the component.
int	scanChar() Returns the next character on the input.
int	scanContent(XMLString content) CHANGED: Scans a range of parsed character data, This function appends the character data to the supplied buffer.
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	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.
void	setBaseSystemId(String systemId)
void	setBufferSize(int size)
void	setColumnNumber(int col)
void	setCurrentEntity(Entity.ScannedEntity scannedEntity) set the instance of current scanned entity.
void	setEncoding(String encoding) Sets the encoding of the scanner.
void	setExpandedSystemId(String systemId)
void	setLineNumber(int line)
void	setLiteralSystemId(String systemId)
void	setPublicId(String publicId)
void	setVersion(String version) the version of the current entity being scanned
void	setXMLVersion(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(char[] s)
boolean	skipString(String s) Skips the specified string appearing immediately on the input.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fCurrentEntity

protected Entity.ScannedEntity fCurrentEntity

fBufferSize

protected int fBufferSize

fEntityManager

protected XMLEntityManager fEntityManager

fSymbolTable

protected SymbolTable fSymbolTable

fErrorReporter

protected XMLErrorReporter fErrorReporter

fAllowJavaEncodings

protected boolean fAllowJavaEncodings

Allow Java encoding names. This feature identifier is: http://apache.org/xml/features/allow-java-encodings

SYMBOL_TABLE

protected static final String SYMBOL_TABLE

Property identifier: symbol table.

See Also:

Constant Field Values

ERROR_REPORTER

protected static final String ERROR_REPORTER

Property identifier: error reporter.

See Also:

Constant Field Values

ALLOW_JAVA_ENCODINGS

protected static final String ALLOW_JAVA_ENCODINGS

Feature identifier: allow Java encodings.

See Also:

Constant Field Values

fPropertyManager

protected PropertyManager fPropertyManager

Constructor Detail

XMLEntityScanner

public XMLEntityScanner()

Default constructor.

XMLEntityScanner

public XMLEntityScanner(PropertyManager propertyManager,
                XMLEntityManager entityManager)

private constructor, this class can only be instantiated within this class. Instance of this class should be obtained using getEntityScanner() or getEntityScanner(ScannedEntity scannedEntity)

See Also:

getEntityScanner(), getEntityScanner(ScannedEntity)

Method Detail

setBufferSize

public final void setBufferSize(int size)

reset

public void reset(PropertyManager propertyManager)

Resets the components.

reset

public void reset(XMLComponentManager componentManager)
           throws XMLConfigurationException

Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.

Parameters:

componentManager - The component manager.

Throws:

SAXException - Thrown by component on initialization error. For example, if a feature or property is required for the operation of the component, the component manager may throw a SAXNotRecognizedException or a SAXNotSupportedException.

XMLConfigurationException

reset

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

getXMLVersion

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.

Specified by:

getXMLVersion in interface XMLLocator

setXMLVersion

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

setCurrentEntity

public final void setCurrentEntity(Entity.ScannedEntity scannedEntity)

set the instance of current scanned entity.

Parameters:

ScannedEntity -

getCurrentEntity

public Entity.ScannedEntity getCurrentEntity()

getBaseSystemId

public final String getBaseSystemId()

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

Specified by:

getBaseSystemId in interface XMLLocator

setBaseSystemId

public void setBaseSystemId(String systemId)

See Also:

XMLResourceIdentifier.setBaseSystemId(String)

getLineNumber

public final int getLineNumber()

Description copied from interface: XMLLocator

Returns the line number, or -1 if no line number is available.

Specified by:

getLineNumber in interface XMLLocator

setLineNumber

public void setLineNumber(int line)

See Also:

jdk7u.jaxp.org.apache.xerces.external.xni.XMLLocator#setLineNumber(int)

getColumnNumber

public final int getColumnNumber()

Description copied from interface: XMLLocator

Returns the column number, or -1 if no column number is available.

Specified by:

getColumnNumber in interface XMLLocator

setColumnNumber

public void setColumnNumber(int col)

See Also:

jdk7u.jaxp.org.apache.xerces.external.xni.XMLLocator#setColumnNumber(int)

getCharacterOffset

public final int getCharacterOffset()

Description copied from interface: XMLLocator

Returns the character offset, or -1 if no character offset is available.

Specified by:

getCharacterOffset in interface XMLLocator

getExpandedSystemId

public final String getExpandedSystemId()

Returns the expanded system identifier.

Specified by:

getExpandedSystemId in interface XMLLocator

setExpandedSystemId

public void setExpandedSystemId(String systemId)

See Also:

XMLResourceIdentifier.setExpandedSystemId(String)

getLiteralSystemId

public final String getLiteralSystemId()

Returns the literal system identifier.

Specified by:

getLiteralSystemId in interface XMLLocator

setLiteralSystemId

public void setLiteralSystemId(String systemId)

See Also:

XMLResourceIdentifier.setLiteralSystemId(String)

getPublicId

public final String getPublicId()

Returns the public identifier.

Specified by:

getPublicId in interface XMLLocator

setPublicId

public void setPublicId(String publicId)

See Also:

XMLResourceIdentifier.setPublicId(String)

setVersion

public void setVersion(String version)

the version of the current entity being scanned

getVersion

public String getVersion()

getEncoding

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.

Specified by:

getEncoding in interface XMLLocator

setEncoding

public final void setEncoding(String encoding)
                       throws IOException

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:

EncodingMap

isExternal

public final boolean isExternal()

Returns true if the current entity being scanned is external.

getChar

public int getChar(int relative)
            throws IOException

Throws:

IOException

peekChar

public int peekChar()
             throws IOException

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.

scanChar

public int scanChar()
             throws IOException

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.

scanNmtoken

public String scanNmtoken()
                   throws IOException

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.

See Also:

SymbolTable, XMLChar.isName(int)

scanName

public String scanName()
                throws IOException

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.

See Also:

SymbolTable, XMLChar.isName(int), XMLChar.isNameStart(int)

scanQName

public boolean scanQName(QName qname)
                  throws IOException

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.

See Also:

SymbolTable, XMLChar.isName(int), XMLChar.isNameStart(int)

scanContent

public int scanContent(XMLString content)
                throws IOException

CHANGED: Scans a range of parsed character data, This function appends the character data to the supplied buffer.

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.

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.

scanLiteral

public int scanLiteral(int quote,
              XMLString content)
                throws IOException

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.

scanData

public boolean scanData(String delimiter,
               XMLStringBuffer buffer)
                 throws IOException

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 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.

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.

skipChar

public boolean skipChar(int c)
                 throws IOException

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.

isSpace

public boolean isSpace(char ch)

skipSpaces

public boolean skipSpaces()
                   throws IOException

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:

XMLChar.isSpace(int)

arrangeCapacity

public boolean arrangeCapacity(int length)
                        throws IOException

Parameters:

legnth - This function checks that following number of characters are available. to the underlying buffer.

Returns:

This function returns true if capacity asked is available.

Throws:

IOException

arrangeCapacity

public boolean arrangeCapacity(int length,
                      boolean changeEntity)
                        throws IOException

Parameters:

legnth - This function checks that following number of characters are available. to the underlying buffer.

if - the underlying function should change the entity

Returns:

This function returns true if capacity asked is available.

Throws:

IOException

skipString

public boolean skipString(String s)
                   throws IOException

Skips the specified string appearing immediately on the input.

Note: The characters are consumed only if all the characters are skipped.

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.

skipString

public boolean skipString(char[] s)
                   throws IOException

Throws:

IOException

createReader

protected Reader createReader(InputStream inputStream,
                  String encoding,
                  Boolean isBigEndian)
                       throws IOException

Creates a reader capable of reading the given input stream in the specified encoding.

Parameters:

inputStream - The input stream.

encoding - The encoding name that the input stream is encoded using. If the user has specified that Java encoding names are allowed, then the encoding name may be a Java encoding name; otherwise, it is an ianaEncoding name.

isBigEndian - For encodings (like uCS-4), whose names cannot specify a byte order, this tells whether the order is bigEndian. null menas unknown or not relevant.

Returns:

Returns a reader.

Throws:

IOException

getEncodingName

protected Object[] getEncodingName(byte[] b4,
                       int count)

Returns the IANA encoding name that is auto-detected from the bytes specified, with the endian-ness of that encoding where appropriate.

Parameters:

b4 - The first four bytes of the input.

count - The number of bytes actually read.

Returns:

a 2-element array: the first element, an IANA-encoding string, the second element a Boolean which is true iff the document is big endian, false if it's little-endian, and null if the distinction isn't relevant.

registerListener

public void registerListener(XMLBufferListener listener)

Registers the listener object and provides callback.

Parameters:

listener - listener to which call back should be provided when scanner buffer is being changed.

skipDeclSpaces

public final boolean skipDeclSpaces()
                             throws IOException

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:

XMLChar.isSpace(int)