| java.lang.Object
 com.sun.xml.stream.XMLEntityReader
All known Subclasses: com.sun.xml.stream.XMLEntityReaderImpl,
| XMLEntityReader | | abstract public class XMLEntityReader implements XMLLocator(Code) | | This class allows various parser scanners to scan basic XML constructs
from entities. This class works directly with the entity manager to
provide this functionality.
There is only one entity scanner and entity manager per parser. The
entity manager could implement the methods to perform entity
scanning, but the entity scanner class allows a cleaner separation
between entity management API and entity scanning.
author:
Andy Clark, IBM
author:
Neeraj Bajaj Sun Microsystems
author:
K.Venugopal Sun Microsystems
version:
$Id: XMLEntityReader.java,v 1.2 2006/04/01 06:01:48 jeffsuttor Exp $
See Also: XMLEntityHandler
See Also: XMLEntityManager |
| Method Summary | |
| abstract public int | getCharacterOffset()
| | abstract public String | getEncoding()
| | abstract public String | getVersion()
| | abstract public boolean | isExternal()
Returns true if the current entity being scanned is external. | | abstract public int | peekChar()
Returns the next character on the input. | | abstract public void | registerListener(XMLBufferListener listener)
| | abstract public int | scanChar()
Returns the next character on the input. | | abstract public int | scanContent(XMLString content)
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. | | abstract public boolean | scanData(String delimiter, XMLStringBuffer data)
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. | | abstract 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. | | abstract 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. | | abstract 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. | | abstract 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. | | abstract public void | setEncoding(String encoding)
Sets the encoding of the scanner. | | abstract public void | setVersion(String version)
| | abstract 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. | | abstract public boolean | skipSpaces()
Skips space characters appearing immediately on the input. | | abstract 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. |
| getCharacterOffset | | abstract public int getCharacterOffset()(Code) | | |
| getVersion | | abstract public String getVersion()(Code) | | get the version of the entity on which reader is operating
|
| isExternal | | abstract public boolean isExternal()(Code) | | Returns true if the current entity being scanned is external.
|
| peekChar | | abstract public int peekChar() throws IOException(Code) | | Returns the next character on the input.
Note: The character is not consumed.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| scanChar | | abstract public int scanChar() throws IOException(Code) | | Returns the next character on the input.
Note: The character is consumed.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| scanContent | | abstract public int scanContent(XMLString content) throws IOException(Code) | | 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 the next character on the input, if known. Thisvalue may be -1 but this does note designateend of file.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| scanData | | abstract public boolean scanData(String delimiter, XMLStringBuffer data) throws IOException(Code) | | 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 characterdata to be scanned.
Parameters:
data - The data structure to fill. Returns true if there is more data to scan, false otherwise.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| scanLiteral | | abstract public int scanLiteral(int quote, XMLString content) throws IOException(Code) | | 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 theattribute value data.
Parameters:
content - The content structure to fill. Returns the next character on the input, if known. Thisvalue may be -1 but this does note designateend of file.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| setVersion | | abstract public void setVersion(String version)(Code) | | the version of the current entity being scanned or the version of the entity on which reader is operating
|
| skipChar | | abstract public boolean skipChar(int c) throws IOException(Code) | | 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 true if the character was skipped.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
| skipSpaces | | abstract public boolean skipSpaces() throws IOException(Code) | | Skips space characters appearing immediately on the input.
Note: The characters are consumed only if they are
space characters.
Returns true if at least one space character was skipped.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file.
See Also: com.sun.xml.stream.xerces.util.XMLChar.isSpace |
| skipString | | abstract public boolean skipString(String s) throws IOException(Code) | | 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 true if the string was skipped.
throws:
IOException - Thrown if i/o error occurs.
throws:
EOFException - Thrown on end of file. |
|
|