com.sun.xml.rpc.sp

Class Parser

java.lang.Object

com.sun.xml.rpc.sp.Parser

public final class Parser
extends Object

This implements a fast non-validating top down parser. This one always processes external parsed entities, strictly adheres to the XML 1.0 specification, and provides useful diagnostics. It supports an optimization allowing faster processing of valid standalone XML documents. For multi-language applications (such as web servers using XML processing to create dynamic content), a method supports choosing a locale for parser diagnostics which is both understood by the message recipient and supported by the parser.

Author:

David Brownell, Zhenghua Li, JAX-RPC RI Development Team

Constructor Summary

Constructors

Constructor and Description
Parser(File file) Create a new non-coalescing parser with the specified input file.
Parser(File file, boolean coalescing, boolean namespaceAware) Create a new parser with the specified input file.
Parser(InputStream in) Create a new non-coalescing parser with the specified input stream.
Parser(InputStream in, boolean coalescing, boolean namespaceAware) Create a new parser with the specified input stream and the coalescing property.

Method Summary

Modifier and Type	Method and Description
Locale	chooseLocale(String[] languages) Chooses a client locale to use for diagnostics, using the first language specified in the list that is supported by this parser.
int	getColumnNumber()
String	getCurName()
String	getCurURI()
String	getCurValue()
EntityResolver	getEntityResolver() Returns the object used to resolve entities
int	getLineNumber()
Locale	getLocale() Returns the diagnostic locale.
String	getPublicId()
String	getSystemId()
boolean	isFastStandalone() Returns true if standalone documents skip processing of all external DTD information.
int	parse() Parse and return the next parsing state.
void	setEntityResolver(EntityResolver r) Lets applications control entity resolution.
void	setFastStandalone(boolean value) Setting this flag enables faster processing of valid standalone documents: external DTD information is not processed, and no attribute normalization or defaulting is done.
void	setLocale(Locale l) Used by applications to request locale for diagnostics.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parser

public Parser(InputStream in,
              boolean coalescing,
              boolean namespaceAware)

Create a new parser with the specified input stream and the coalescing property.

Parameters:

in - the input stream.

coalescing - the parser will coalesce character data if, and only if, this parameter is true

namespaceAware - the parser will support namespaces if, and only if, this parameter is true

Parser

public Parser(InputStream in)

Create a new non-coalescing parser with the specified input stream.

Parameters:

in - the input stream.

Parser

public Parser(File file,
              boolean coalescing,
              boolean namespaceAware)
       throws IOException

Create a new parser with the specified input file. and the coalescing property.

Parameters:

file - the input file.

coalescing - the parser will coalesce character data if, and only if, this parameter is true

namespaceAware - the parser will support namespaces if, and only if, this parameter is true

Throws:

IOException

Parser

public Parser(File file)
       throws IOException

Create a new non-coalescing parser with the specified input file.

Parameters:

file - the input file.

Throws:

IOException

Method Detail

setLocale

public void setLocale(Locale l)
               throws ParseException

Used by applications to request locale for diagnostics.

Parameters:

l - The locale to use, or null to use system defaults (which may include only message IDs).

Throws:

ParseException - If no diagnostic messages are available in that locale.

getLocale

public Locale getLocale()

Returns the diagnostic locale.

getCurName

public String getCurName()

getCurURI

public String getCurURI()

getCurValue

public String getCurValue()

getLineNumber

public int getLineNumber()

getColumnNumber

public int getColumnNumber()

getPublicId

public String getPublicId()

getSystemId

public String getSystemId()

chooseLocale

public Locale chooseLocale(String[] languages)
                    throws ParseException

Chooses a client locale to use for diagnostics, using the first language specified in the list that is supported by this parser. That locale is then set using setLocale(). Such a list could be provided by a variety of user preference mechanisms, including the HTTP Accept-Language header field.

Parameters:

languages - Array of language specifiers, ordered with the most preferable one at the front. For example, "en-ca" then "fr-ca", followed by "zh_CN". Both RFC 1766 and Java styles are supported.

Returns:

The chosen locale, or null.

Throws:

ParseException

See Also:

MessageCatalog

setEntityResolver

public void setEntityResolver(EntityResolver r)

Lets applications control entity resolution.

getEntityResolver

public EntityResolver getEntityResolver()

Returns the object used to resolve entities

setFastStandalone

public void setFastStandalone(boolean value)

Setting this flag enables faster processing of valid standalone documents: external DTD information is not processed, and no attribute normalization or defaulting is done. This optimization is only permitted in non-validating parsers; for validating parsers, this mode is silently disabled.

For documents which are declared as standalone, but which are not valid, a fatal error may be reported for references to externally defined entities. That could happen in any nonvalidating parser which did not read externally defined entities. Also, if any attribute values need normalization or defaulting, it will not be done.

isFastStandalone

public boolean isFastStandalone()

Returns true if standalone documents skip processing of all external DTD information.

parse

public int parse()
          throws ParseException,
                 IOException

Parse and return the next parsing state. This is the entry point for higher level parsers like the StreamingParser.

Throws:

ParseException

IOException