org.apache.xerces.impl

Class XML11EntityScanner

public class XML11EntityScanner extends XMLEntityScanner

Implements the entity scanner methods in the context of XML 1.1.

Version: $Id: XML11EntityScanner.java,v 1.14 2004/10/04 21:45:49 mrglavas Exp $

Author: Michael Glavassevich, IBM Neil Graham, IBM

UNKNOWN:

Constructor Summary
XML11EntityScanner()
Default constructor.
Method Summary
intpeekChar()
Returns the next character on the input.
intscanChar()
Returns the next character on the input.
intscanContent(XMLString content)
Scans a range of parsed character data, setting the fields of the XMLString structure, appropriately.
booleanscanData(String delimiter, XMLStringBuffer buffer)
Scans a range of character data up to the specicied delimiter, setting the fields of the XMLString structure, appropriately.
intscanLiteral(int quote, XMLString content)
Scans a range of attribute value data, setting the fields of the XMLString structure, appropriately.
StringscanName()
Returns a string matching the Name production appearing immediately on the input as a symbol, or null if no Name string is present.
StringscanNCName()
Returns a string matching the NCName production appearing immediately on the input as a symbol, or null if no NCName string is present.
StringscanNmtoken()
Returns a string matching the NMTOKEN production appearing immediately on the input as a symbol, or null if NMTOKEN Name string is present.
booleanscanQName(QName qname)
Scans a qualified name from the input, setting the fields of the QName structure appropriately.
booleanskipChar(int c)
Skips a character appearing immediately on the input.
booleanskipSpaces()
Skips space characters appearing immediately on the input.
booleanskipString(String s)
Skips the specified string appearing immediately on the input.

Constructor Detail

XML11EntityScanner

public XML11EntityScanner()
Default constructor.

Method Detail

peekChar

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.

scanChar

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.

scanContent

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.

scanData

public boolean scanData(String delimiter, XMLStringBuffer buffer)
Scans a range of character data up to the specicied 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. data The data structure 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.

scanLiteral

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.

scanName

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.

See Also: SymbolTable XML11Char XML11Char

scanNCName

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.

See Also: SymbolTable XML11Char XML11Char

scanNmtoken

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.

See Also: SymbolTable XML11Char

scanQName

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.

See Also: SymbolTable XML11Char XML11Char

skipChar

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.

skipSpaces

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: XMLChar XML11Char

skipString

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.

Copyright © 1999-2005 Apache XML Project. All Rights Reserved.