Package org.openpreservation.format.xml

Class XmlParser

java.lang.Object

org.openpreservation.format.xml.XmlParser

public final class XmlParser
extends Object

Class to wrap the checking of XML files for well-formedness and validity.

Author:

Carl Wilson

Constructor Summary

Constructors

Constructor	Description
XmlParser()	Default constructor for the XmlParser class.

Method Summary

Modifier and Type	Method	Description
static final SAXParserFactory	getNonValidatingFactory()	Convenience method to obtain a pre-configured SAXParserFactory that is not validating and is namespace aware.
ParseResult	parse(InputStream toTest)	Parses the supplied InputStream for well-formedness and returns a ParseResult object.
ParseResult	parse(Path toTest)	Parses the supplied Path for well-formedness and returns a ParseResult object.

Methods inherited from class java.lang.Object

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

Constructor Details

XmlParser

public XmlParser()
          throws ParserConfigurationException,
SAXException

Default constructor for the XmlParser class.

Throws:

ParserConfigurationException - if the parser can not be configured

SAXException - if the parser can not be created

Method Details

getNonValidatingFactory

public static final SAXParserFactory getNonValidatingFactory()
                                                      throws SAXNotRecognizedException,
SAXNotSupportedException,
ParserConfigurationException

Convenience method to obtain a pre-configured SAXParserFactory that is not validating and is namespace aware.

Returns:

a pre-configured SAXParserFactory that is not validating and is namespace aware.

Throws:

SAXNotRecognizedException - When the underlying XMLReader does not recognize the property name.

SAXNotSupportedException - When the underlying XMLReader recognizes the property name but doesn't support the property.

ParserConfigurationException - When the underlying XMLReader is not configured correctly.

parse

public ParseResult parse(InputStream toTest)
                  throws IOException

Parses the supplied InputStream for well-formedness and returns a ParseResult object.

Parameters:

toTest - an InputStream to be parsed.

Returns:

a ParseResult object containing the result of the parse.

Throws:

IOException - if the supplied InputStream can not be read.

parse

public ParseResult parse(Path toTest)
                  throws IOException

Parses the supplied Path for well-formedness and returns a ParseResult object.

Parameters:

toTest - a Path to be parsed.

Returns:

a ParseResult object containing the result of the parse.

Throws:

IOException - if the supplied Path can not be read.