Module eclipselink

Package org.eclipse.persistence.platform.xml.jaxp

Class JAXPParser

java.lang.Object

org.eclipse.persistence.platform.xml.jaxp.JAXPParser

All Implemented Interfaces:

XMLParser

public class JAXPParser
extends Object
implements XMLParser

Purpose: An implementation of XMLParser using JAXP 1.3 APIs.

JAXPParser is NOT thread safe.

Field Summary

Fields inherited from interface org.eclipse.persistence.platform.xml.XMLParser

DTD_VALIDATION, NONVALIDATING, SCHEMA_VALIDATION

Constructor Summary

Constructors

Constructor	Description
JAXPParser()	Default constructor.
JAXPParser(Map<String,Boolean> parserFeatures)	This constructor provides way to specify features for parser.
JAXPParser(DocumentBuilderFactory documentBuilderFactory, ErrorHandler errorHandler)	This constructor can increase performance by providing existing documentBuilderFactory and errorHandler.

Method Summary

Modifier and Type	Method	Description
EntityResolver	getEntityResolver()	Returns entity resolver of the parser.
ErrorHandler	getErrorHandler()	Returns error handler of the parser.
int	getValidationMode()	Returns validtion mode of the parser.
Schema	getXMLSchema()	Returns XML Schema of the parser.
Document	parse(File file)	Parses given file.
Document	parse(InputStream inputStream)	Parses given input stream.
Document	parse(Reader reader)	Parses given reader.
Document	parse(URL url)	Parses given url.
Document	parse(Source source)	Parses given source.
Document	parse(InputSource inputSource)	Parses given input source.
void	setEntityResolver(EntityResolver entityResolver)	Sets entity resolver for the parser.
void	setErrorHandler(ErrorHandler errorHandler)	Sets error handler for the parser.
void	setNamespaceAware(boolean isNamespaceAware)	Changes namespaceAware behavior of the parser.
void	setValidationMode(int validationMode)	Sets validation mode of the parser.
void	setWhitespacePreserving(boolean isWhitespacePreserving)	Changes preservation of white spaces.
void	setXMLSchema(URL url)	Sets XML Schema for the parser.
void	setXMLSchema(Schema schema)	Sets XML Schema for the parser.
void	setXMLSchemas(Object[] schemas)	Sets XML Schema(s) for the parser.

Methods inherited from class java.lang.Object

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

Constructor Detail

JAXPParser

public JAXPParser()

Default constructor.

JAXPParser

public JAXPParser(DocumentBuilderFactory documentBuilderFactory,
                  ErrorHandler errorHandler)

This constructor can increase performance by providing existing documentBuilderFactory and errorHandler.

Parameters:

documentBuilderFactory - existing document builder factory

errorHandler - existing error handler

JAXPParser

public JAXPParser(Map<String,Boolean> parserFeatures)

This constructor provides way to specify features for parser.

Parameters:

parserFeatures - features for parser

Method Detail

setNamespaceAware

public void setNamespaceAware(boolean isNamespaceAware)

Changes namespaceAware behavior of the parser.

Specified by:

setNamespaceAware in interface XMLParser

Parameters:

isNamespaceAware - if the parser should be namespace aware

setWhitespacePreserving

public void setWhitespacePreserving(boolean isWhitespacePreserving)

Changes preservation of white spaces.

Specified by:

setWhitespacePreserving in interface XMLParser

Parameters:

isWhitespacePreserving - if the parser should preserve white spaces

getValidationMode

public int getValidationMode()

Returns validtion mode of the parser.

Specified by:

getValidationMode in interface XMLParser

Returns:

validation mode of the parser

setValidationMode

public void setValidationMode(int validationMode)

Sets validation mode of the parser.

Specified by:

setValidationMode in interface XMLParser

Parameters:

validationMode - validation mode to set

getEntityResolver

public EntityResolver getEntityResolver()

Returns entity resolver of the parser.

Specified by:

getEntityResolver in interface XMLParser

Returns:

entity resolver of the parser

setEntityResolver

public void setEntityResolver(EntityResolver entityResolver)

Sets entity resolver for the parser.

Specified by:

setEntityResolver in interface XMLParser

Parameters:

entityResolver - entity resolver to set

getErrorHandler

public ErrorHandler getErrorHandler()

Returns error handler of the parser.

Specified by:

getErrorHandler in interface XMLParser

Returns:

error handler of the parser

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Sets error handler for the parser.

Specified by:

setErrorHandler in interface XMLParser

Parameters:

errorHandler - error handler for the parser

setXMLSchema

public void setXMLSchema(URL url)
                  throws XMLPlatformException

Sets XML Schema for the parser.

Specified by:

setXMLSchema in interface XMLParser

Parameters:

url - url of the XMLSchema

Throws:

XMLPlatformException - exception occurred while setting XMLSchema

setXMLSchema

public void setXMLSchema(Schema schema)
                  throws XMLPlatformException

Sets XML Schema for the parser.

Specified by:

setXMLSchema in interface XMLParser

Parameters:

schema - schema for the parser

Throws:

XMLPlatformException - exception occurred while setting XMLSchema

getXMLSchema

public Schema getXMLSchema()
                    throws XMLPlatformException

Returns XML Schema of the parser.

Specified by:

getXMLSchema in interface XMLParser

Returns:

schema of the parser

Throws:

XMLPlatformException - exception occurred while getting XMLSchema

setXMLSchemas

public void setXMLSchemas(Object[] schemas)
                   throws XMLPlatformException

Sets XML Schema(s) for the parser.

Specified by:

setXMLSchemas in interface XMLParser

Parameters:

schemas - XML schemas to set

Throws:

XMLPlatformException - exception occurred while setting XMLSchema(s)

parse

public Document parse(InputSource inputSource)
               throws XMLPlatformException

Parses given input source.

Specified by:

parse in interface XMLParser

Parameters:

inputSource - input source to parse

Returns:

parsed document

Throws:

XMLPlatformException - exception occurred while parsing input source

parse

public Document parse(File file)
               throws XMLPlatformException

Parses given file.

Specified by:

parse in interface XMLParser

Parameters:

file - file to parse

Returns:

parsed document

Throws:

XMLPlatformException - exception occurred while parsing given file

parse

public Document parse(InputStream inputStream)
               throws XMLPlatformException

Parses given input stream.

Specified by:

parse in interface XMLParser

Parameters:

inputStream - input stream to parse

Returns:

parsed document

Throws:

XMLPlatformException - exception occurred while parsing input stream

parse

public Document parse(Reader reader)
               throws XMLPlatformException

Parses given reader.

Specified by:

parse in interface XMLParser

Parameters:

reader - reader to parse

Returns:

parsed document

Throws:

XMLPlatformException - exception occurred while parsing given reader

parse

public Document parse(Source source)
               throws XMLPlatformException

Parses given source.

Specified by:

parse in interface XMLParser

Parameters:

source - source to parse

Returns:

parsed document

Throws:

XMLPlatformException - exception occurred while parsing given source

parse

public Document parse(URL url)
               throws XMLPlatformException

Parses given url.

Specified by:

parse in interface XMLParser

Parameters:

url - url to parse

Returns:

parsed document

Throws:

XMLPlatformException - exception occurred while parsing stream with given url