Package com.sun.xml.rpc.sp

Class StreamingParserImpl

java.lang.Object

com.sun.xml.rpc.sp.StreamingParser

com.sun.xml.rpc.sp.StreamingParserImpl

public final class StreamingParserImpl
extends StreamingParser

A demand-driven streaming parser implementation.

Author:

Zhenghua Li, JAX-RPC RI Development Team

Field Summary

Fields inherited from class com.sun.xml.rpc.sp.StreamingParser

ATTR, CHARS, END, IWS, PI, START

Method Summary

Modifier and Type	Method	Description
int	column()	Returns the column number of the current component, or -1 if the column number is not known.
String	describe(boolean articleNeeded)	Constructs a string describing the current state of this parser, suitable for use in an error message or an exception detail string.
boolean	isCoalescing()	Returns the coalescing property of this parser.
boolean	isNamespaceAware()	Returns the namespaceAware property of this parser.
boolean	isValidating()	Returns the validating property of this parser.
int	line()	Returns the line number of the current component, or -1 if the line number is not known.
String	name()	Returns a name string whose meaning depends upon the current state.
int	parse()	Parses the next component of the document being parsed.
String	publicId()	Returns the public identifer of the document being parsed, or null if it has none.
int	state()	Returns the current state of the parser.
String	systemId()	Returns the system identifer of the document being parsed, or null if it has none.
String	uriString()	Returns the URI string of the current component.
String	value()	Returns a value string whose meaning depends upon the current state.

Methods inherited from class com.sun.xml.rpc.sp.StreamingParser

describe, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

parse

public int parse()
          throws ParseException,
                 IOException

Parses the next component of the document being parsed.

Specified by:

parse in class StreamingParser

Returns:

The parser's current state, one of StreamingParser.START, StreamingParser.END, StreamingParser.ATTR, StreamingParser.CHARS, StreamingParser.IWS, or StreamingParser.PI, or -1 if the end of the document has been reached

Throws:

ParseException - If an XML parsing error occurs

IOException - If an I/O error occurs

state

public int state()

Returns the current state of the parser.

Specified by:

state in class StreamingParser

Returns:

The parser's current state, one of StreamingParser.START, StreamingParser.END, StreamingParser.ATTR, StreamingParser.CHARS, StreamingParser.IWS, or StreamingParser.PI, or -1 if the end of the document has been reached.

Throws:

IllegalStateException - If the parser has yet not been started by invoking the parse() method

name

public String name()

Returns a name string whose meaning depends upon the current state.

Specified by:

name in class StreamingParser

Throws:

IllegalStateException - If there is no name data for the current parser state

value

public String value()

Returns a value string whose meaning depends upon the current state.

Specified by:

value in class StreamingParser

Throws:

IllegalStateException - If there is no value data for the current parser state

uriString

public String uriString()

Returns the URI string of the current component.

Specified by:

uriString in class StreamingParser

Throws:

IllegalStateException - If there is no URI for the current component

line

public int line()

Returns the line number of the current component, or -1 if the line number is not known.

Specified by:

line in class StreamingParser

column

public int column()

Returns the column number of the current component, or -1 if the column number is not known.

Specified by:

column in class StreamingParser

publicId

public String publicId()

Returns the public identifer of the document being parsed, or null if it has none.

Specified by:

publicId in class StreamingParser

systemId

public String systemId()

Returns the system identifer of the document being parsed, or null if it has none.

Specified by:

systemId in class StreamingParser

isValidating

public boolean isValidating()

Returns the validating property of this parser.

Specified by:

isValidating in class StreamingParser

Returns:

true if, and only if, this parser will perform validation

isCoalescing

public boolean isCoalescing()

Returns the coalescing property of this parser.

Specified by:

isCoalescing in class StreamingParser

Returns:

true if, and only if, this parser will coalesce adjacent runs of character data

isNamespaceAware

public boolean isNamespaceAware()

Returns the namespaceAware property of this parser.

Specified by:

isNamespaceAware in class StreamingParser

Returns:

true if, and only if, this parser will support namespace

describe

public String describe(boolean articleNeeded)

Constructs a string describing the current state of this parser, suitable for use in an error message or an exception detail string.

Specified by:

describe in class StreamingParser

Parameters:

articleNeeded - Whether an appropriate article ("a", "an", "some", or "the") is to be prepended to the description string

Returns:

A string describing the given parser state.