com.ibm.xml.framework
Interface XMLScanner

public abstract interface XMLScanner

This is the interface to the scanner. This class also provides the parser with location information through the Locator interface.

Version:

Revision: 55 1.6 src/com/ibm/xml/framework/XMLScanner.java, parser, xml4j2, xml4j2_0_0

See Also:

XMLParser, InputSource, Locator

Method Summary

int	getCurrentContentSpecType() This method is temporary until we restructure the interface between DefaultScanner#scanContent and XMLReader#scanContent.
Locator	getLocator() Return a Locator object for the parser to use.
void	reset(ParserState parserState) Reset scanner between calls to scanDocument.
void	scanDocument(InputSource source) Process the XML file.
void	stop() Stops the scanner in a reasonable place and returns.

Method Detail

reset

public void reset(ParserState parserState)

Reset scanner between calls to scanDocument.

Parameters:

parserState - The state to be used for the next parse.

See Also:

ParserState

scanDocument

public void scanDocument(InputSource source)
                  throws java.lang.Exception

Process the XML file. The scanner stores the markup information in the pools provided by the parser and calls the handlers provided by the parser.

Parameters:

source - Where to find the XML data.

See Also:

InputSource

getCurrentContentSpecType

public int getCurrentContentSpecType()

This method is temporary until we restructure the interface between DefaultScanner#scanContent and XMLReader#scanContent.

Returns:

The ContentSpecType for the current element.

See Also:

ElementDecl, ElementDeclPool.getContentSpecType(int)

getLocator

public Locator getLocator()

Return a Locator object for the parser to use.

Returns:

The locator.

stop

public void stop()

Stops the scanner in a reasonable place and returns.