Package org.smooks.engine.delivery.sax.ng.org.apache.xerces.impl

Class XML11EntityScanner

  • All Implemented Interfaces:
    XMLLocator
    public class XML11EntityScanner
extends XMLEntityScanner
    Implements the entity scanner methods in the context of XML 1.1.
    Version:
    $Id$
    Author:
    Michael Glavassevich, IBM, Neil Graham, IBM

    • Constructor Detail

      • XML11EntityScanner

        public XML11EntityScanner()
        Default constructor.

    • Method Detail

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

        Overrides:
        scanNmtoken in class XMLEntityScanner
        Throws:
        IOException - Thrown if i/o error occurs.
        EOFException - Thrown on end of file.
        See Also:
        SymbolTable, XML11Char.isXML11Name(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.

        Overrides:
        scanQName in class XMLEntityScanner
        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.isXML11Name(int), XML11Char.isXML11NameStart(int)

      • scanContent

        public int scanContent​(XMLString content)
                throws IOException
        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.

        Overrides:
        scanContent in class XMLEntityScanner
        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.

        Overrides:
        scanLiteral in class XMLEntityScanner
        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 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.

        Overrides:
        scanData in class XMLEntityScanner
        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.

        Overrides:
        skipChar in class XMLEntityScanner
        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.

      • skipString

        public boolean skipString​(String s)
                   throws IOException
        Skips the specified string appearing immediately on the input.

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

        Overrides:
        skipString in class XMLEntityScanner
        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.