Overview | Package | Class | Use | Tree | Deprecated | Index | Help
|  | BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## BEA WebLogic Server 9.0 API Reference

## weblogic.apache.xerces.impl
Class XMLEntityManager.EntityScanner

    java.lang.Object
      weblogic.apache.xerces.impl.XMLEntityScanner
          weblogic.apache.xerces.impl.XMLEntityManager.EntityScanner

All Implemented Interfaces:
  XMLLocator, XMLResourceIdentifier

Direct Known Subclasses:
  XML11EntityManager.XML11EntityScanner

Enclosing class:
  XMLEntityManager

protected class XMLEntityManager.EntityScanner
extends XMLEntityScanner

Implements the entity scanner methods.

Constructor Summary
`XMLEntityManager.EntityScanner()` Default constructor.

Method Summary
`String` | `getBaseSystemId()` Returns the base system identifier of the currently scanned entity, or null if none is available.
`int` | `getColumnNumber()` Return the column number where the current document event ends.
`String` | `getExpandedSystemId()` Return the expanded system identifier for the current document event.
`int` | `getLineNumber()` Return the line number where the current document event ends.
`String` | `getLiteralSystemId()` Return the literal system identifier for the current document event.
`String` | `getPublicId()` Return the public identifier for the current document event.
`boolean` | `isExternal()` Returns true if the current entity being scanned is external.
`int` | `peekChar()` Returns the next character on the input.
`int` | `scanChar()` Returns the next character on the input.
`int` | `scanContent(XMLString content)` Scans a range of parsed character data, setting the fields of the XMLString structure, appropriately.
`boolean` | `scanData(String delimiter, XMLString data)` Scans a range of character data up to the specicied 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` | `setEncoding(String encoding)` Sets the encoding of the scanner.
`boolean` | `skipChar(int c)` Skips a character appearing immediately on the input.
`boolean` | `skipSpaces()` Skips space characters appearing immediately on the input.
`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`

Constructor Detail

### XMLEntityManager.EntityScanner

    public XMLEntityManager.EntityScanner()

  Default constructor.

Method Detail

### getBaseSystemId

    public String getBaseSystemId()

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

  Specified by:
    `getBaseSystemId` in interface `XMLResourceIdentifier`
  Specified by:
    `getBaseSystemId` in class `XMLEntityScanner`

### getColumnNumber

    public int getColumnNumber()

  Return the column number where the current document event ends.

  Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.

  The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears.

  If possible, the SAX driver should provide the line position of the first character after the text associated with the document event.

  If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first column in each line is column 1.

  Returns:
    The column number, or -1 if none is available.

### getExpandedSystemId

    public String getExpandedSystemId()

  Return the expanded system identifier for the current document event.

  The return value is the expanded system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

  If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

  Returns:
    A string containing the expanded system identifier, or null if none is available.

### getLineNumber

    public int getLineNumber()

  Return the line number where the current document event ends.

  Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.

  The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears.

  If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first line in the document is line 1.

  Returns:
    The line number, or -1 if none is available.

### getLiteralSystemId

    public String getLiteralSystemId()

  Return the literal system identifier for the current document event.

  The return value is the literal system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

  Returns:
    A string containing the literal system identifier, or null if none is available.

### getPublicId

    public String getPublicId()

  Return the public identifier for the current document event.

  The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

  Returns:
    A string containing the public identifier, or null if none is available.

### isExternal

    public boolean isExternal()

  Returns true if the current entity being scanned is external.

  Specified by:
    `isExternal` in class `XMLEntityScanner`

### peekChar

    public int peekChar()
                 throws IOException

  Returns the next character on the input.

  Note: The character is not consumed.

  Specified by:
    `peekChar` in class `XMLEntityScanner`
  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.

  Specified by:
    `scanChar` in class `XMLEntityScanner`
  Throws:
    `IOException` - Thrown if i/o error occurs.
    `EOFException` - Thrown on end of file.

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

  Specified by:
    `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.

### scanData

    public boolean scanData(String delimiter,
                            XMLString data)
                     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.

  Specified by:
    `scanData` in class `XMLEntityScanner`
  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)
                    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.

  Specified by:
    `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.

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

  Specified by:
    `scanName` in class `XMLEntityScanner`
  Throws:
    `IOException` - Thrown if i/o error occurs.
    `EOFException` - Thrown on end of file.
  See Also:
    `SymbolTable`, `XMLChar.isName(int)`, `XMLChar.isNameStart(int)`

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

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

  Specified by:
    `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`, `XMLChar.isName(int)`, `XMLChar.isNameStart(int)`

### setEncoding

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

  Specified by:
    `setEncoding` in class `XMLEntityScanner`
  Parameters:
    `encoding` - The IANA encoding name of the new encoding.
  Throws:
    `IOException` - Thrown if the new encoding is not supported.
  See Also:
    `EncodingMap`

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

  Specified by:
    `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.

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

  Specified by:
    `skipSpaces` in class `XMLEntityScanner`
  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)`

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

  Specified by:
    `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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Documentation is available at http://e-docs.bea.com/wls/docs90 Copyright 2005 BEA Systems Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD