Top Description Fields Constructors Methods
org.apache.xerces.impl

public Class XML11EntityScanner

extends XMLEntityScanner
Class Inheritance
Imports
java.io.EOFException, .IOException, org.apache.xerces.impl.msg.XMLMessageFormatter, org.apache.xerces.util.XML11Char, .XMLChar, .XMLStringBuffer, org.apache.xerces.xni.QName, .XMLString

Implements the entity scanner methods in the context of XML 1.1.
Authors
Michael Glavassevich, IBM, Neil Graham, IBM
Version
$Id: XML11EntityScanner.java 1897159 2022-01-17 20:48:22Z mrglavas $

Field Summary

Inherited from org.apache.xerces.impl.XMLEntityScanner:
fBufferSizefCurrentEntityfErrorReporterfSymbolTable

Constructor Summary

AccessConstructor and Description
public
XML11EntityScanner()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public int
peekChar()

Overrides org.apache.xerces.impl.XMLEntityScanner.peekChar.

Returns the next character on the input.
public int
scanChar()

Overrides org.apache.xerces.impl.XMLEntityScanner.scanChar.

Returns the next character on the input.
public int

Returns:

Returns the next character on the input, if known. This value may be -1 but this does note designate end of file.
scanContent
(XMLString
The content structure to fill.
content
)

Overrides org.apache.xerces.impl.XMLEntityScanner.scanContent.

Scans a range of parsed character data, setting the fields of the XMLString structure, appropriately.
public boolean

Returns:

Returns true if there is more data to scan, false otherwise.
scanData
(String
The string that signifies the end of the character data to be scanned.
delimiter
,
XMLStringBuffer
The XMLStringBuffer to fill.
buffer
)

Overrides org.apache.xerces.impl.XMLEntityScanner.scanData.

Scans a range of character data up to the specicied delimiter, setting the fields of the XMLString structure, appropriately.
public int

Returns:

Returns the next character on the input, if known. This value may be -1 but this does note designate end of file.
scanLiteral
(int
The quote character that signifies the end of the attribute value data.
quote
,
XMLString
The content structure to fill.
content
)

Overrides org.apache.xerces.impl.XMLEntityScanner.scanLiteral.

Scans a range of attribute value data, setting the fields of the XMLString structure, appropriately.
public String
scanName()

Overrides org.apache.xerces.impl.XMLEntityScanner.scanName.

Returns a string matching the Name production appearing immediately on the input as a symbol, or null if no Name string is present.
public String
scanNCName()

Overrides org.apache.xerces.impl.XMLEntityScanner.scanNCName.

Returns a string matching the NCName production appearing immediately on the input as a symbol, or null if no NCName string is present.
public String
scanNmtoken()

Overrides org.apache.xerces.impl.XMLEntityScanner.scanNmtoken.

Returns a string matching the NMTOKEN production appearing immediately on the input as a symbol, or null if NMTOKEN Name string is present.
public boolean

Returns:

Returns true if a qualified name appeared immediately on the input and was scanned, false otherwise.
scanQName
(QName
The qualified name structure to fill.
qname
)

Overrides org.apache.xerces.impl.XMLEntityScanner.scanQName.

Scans a qualified name from the input, setting the fields of the QName structure appropriately.
public boolean

Returns:

Returns true if the character was skipped.
skipChar
(int
The character to skip.
c
)

Overrides org.apache.xerces.impl.XMLEntityScanner.skipChar.

Skips a character appearing immediately on the input.
public boolean

Returns:

Returns true if at least one space character was skipped.
skipSpaces
()

Overrides org.apache.xerces.impl.XMLEntityScanner.skipSpaces.

Skips space characters appearing immediately on the input.
public boolean

Returns:

Returns true if the string was skipped.
skipString
(String
The string to skip.
s
)

Overrides org.apache.xerces.impl.XMLEntityScanner.skipString.

Skips the specified string appearing immediately on the input.
Inherited from org.apache.xerces.impl.XMLEntityScanner:
getBaseSystemIdgetCharacterOffsetgetColumnNumbergetEncodinggetExpandedSystemIdgetLineNumbergetLiteralSystemIdgetPublicIdgetXMLVersionisExternalloadresetresizeBuffersetBufferSizesetCurrentEntitysetEncodingsetXMLVersionskipDeclSpaces

Constructor Detail

XML11EntityScannerback to summary
public XML11EntityScanner()

Default constructor.

Method Detail

peekCharback to summary
public int peekChar() throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.peekChar.

Returns the next character on the input.

Note

The character is not consumed.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
scanCharback to summary
public int scanChar() throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.scanChar.

Returns the next character on the input.

Note

The character is consumed.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
scanContentback to summary
public int scanContent(XMLString content) throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.scanContent.

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:XMLString

The content structure to fill.

Returns:int

Returns the next character on the input, if known. This value may be -1 but this does note designate end of file.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
scanDataback to summary
public boolean scanData(String delimiter, XMLStringBuffer buffer) throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.scanData.

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:String

The string that signifies the end of the character data to be scanned.

buffer:XMLStringBuffer

The XMLStringBuffer to fill.

Returns:boolean

Returns true if there is more data to scan, false otherwise.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
scanLiteralback to summary
public int scanLiteral(int quote, XMLString content) throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.scanLiteral.

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:int

The quote character that signifies the end of the attribute value data.

content:XMLString

The content structure to fill.

Returns:int

Returns the next character on the input, if known. This value may be -1 but this does note designate end of file.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
scanNameback to summary
public String scanName() throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.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.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
See Also
org.apache.xerces.util.SymbolTable, org.apache.xerces.util.XML11Char#isXML11Name, org.apache.xerces.util.XML11Char#isXML11NameStart
scanNCNameback to summary
public String scanNCName() throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.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.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
See Also
org.apache.xerces.util.SymbolTable, org.apache.xerces.util.XML11Char#isXML11NCName, org.apache.xerces.util.XML11Char#isXML11NCNameStart
scanNmtokenback to summary
public String scanNmtoken() throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.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.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
See Also
org.apache.xerces.util.SymbolTable, org.apache.xerces.util.XML11Char#isXML11Name
scanQNameback to summary
public boolean scanQName(QName qname) throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.scanQName.

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:QName

The qualified name structure to fill.

Returns:boolean

Returns true if a qualified name appeared immediately on the input and was scanned, false otherwise.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
See Also
org.apache.xerces.util.SymbolTable, org.apache.xerces.util.XML11Char#isXML11Name, org.apache.xerces.util.XML11Char#isXML11NameStart
skipCharback to summary
public boolean skipChar(int c) throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.skipChar.

Skips a character appearing immediately on the input.

Note

The character is consumed only if it matches the specified character.

Parameters
c:int

The character to skip.

Returns:boolean

Returns true if the character was skipped.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
skipSpacesback to summary
public boolean skipSpaces() throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.skipSpaces.

Skips space characters appearing immediately on the input.

Note

The characters are consumed only if they are space characters.

Returns:boolean

Returns true if at least one space character was skipped.

Exceptions
IOException:
Thrown if i/o error occurs.
EOFException:
Thrown on end of file.
See Also
org.apache.xerces.util.XMLChar#isSpace, org.apache.xerces.util.XML11Char#isXML11Space
skipStringback to summary
public boolean skipString(String s) throws IOException

Overrides org.apache.xerces.impl.XMLEntityScanner.skipString.

Skips the specified string appearing immediately on the input.

Note

The characters are consumed only if they are space characters.

Parameters
s:String

The string to skip.

Returns:boolean

Returns true if the string was skipped.

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