org.jdom2.input.sax.XMLReaders Maven / Gradle / Ivy
Show all versions of jdom Show documentation
/*--
Copyright (C) 2011 Jason Hunter & Brett McLaughlin.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions, and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions, and the disclaimer that follows
these conditions in the documentation and/or other materials
provided with the distribution.
3. The name "JDOM" must not be used to endorse or promote products
derived from this software without prior written permission. For
written permission, please contact .
4. Products derived from this software may not be called "JDOM", nor
may "JDOM" appear in their name, without prior written permission
from the JDOM Project Management .
In addition, we request (but do not require) that you include in the
end-user documentation provided with the redistribution and/or in the
software itself an acknowledgement equivalent to the following:
"This product includes software developed by the
JDOM Project (http://www.jdom.org/)."
Alternatively, the acknowledgment may be graphical using the logos
available at http://www.jdom.org/images/logos.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
This software consists of voluntary contributions made by many
individuals on behalf of the JDOM Project and was originally
created by Jason Hunter and
Brett McLaughlin . For more information
on the JDOM Project, please see .
*/
package org.jdom2.input.sax;
import javax.xml.XMLConstants;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParserFactory;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;
import org.jdom2.JDOMException;
/**
* An enumeration of {@link XMLReaderJDOMFactory} that allows for a single
* central location to create XMLReaders. The Singletons (members) of this
* enumeration can produce the most common XMLReaders: non-validating, XSD
* validating, and DocType validating.
*
* See the {@link org.jdom2.input.sax package documentation} for details of how
* to create the SAXParser you desire.
*
* @see org.jdom2.input.sax
* @author Rolf Lear
*/
public enum XMLReaders implements XMLReaderJDOMFactory {
/**
* The non-validating singleton
*/
NONVALIDATING(0),
/**
* The DTD-validating Singleton
*/
DTDVALIDATING(1),
/**
* The XSD-validating Singleton
*/
XSDVALIDATING(2);
/** the actual SAXParserFactory in the respective singletons. */
private final SAXParserFactory jaxpfactory;
/** Is this a validating parser */
private final boolean validates;
/** Private constructor */
private XMLReaders(int validate) {
SAXParserFactory fac = SAXParserFactory.newInstance();
boolean val = false;
// All JDOM parsers are namespace aware.
fac.setNamespaceAware(true);
switch (validate) {
case 0:
fac.setValidating(false);
break;
case 1:
fac.setValidating(true);
val = true;
break;
case 2:
fac.setValidating(false);
try {
SchemaFactory sfac = SchemaFactory.
newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
Schema schema = sfac.newSchema();
fac.setSchema(schema);
val = true;
} catch (SAXException se) {
// we could not get a validating system, set the fac to null
fac = null;
} catch (IllegalArgumentException iae) {
// this system does not support XSD Validation.... which is true for android!
// we could not get a validating system, set the fac to null
fac = null;
}
break;
}
jaxpfactory = fac;
validates = val;
}
/**
* Get a new XMLReader from this JAXP-based {@link XMLReaderJDOMFactory}.
*
*
* @return a new XMLReader instance.
* @throws JDOMException
* if there is a problem creating the XMLReader
*/
@Override
public XMLReader createXMLReader() throws JDOMException {
if (jaxpfactory == null) {
throw new JDOMException("It was not possible to configure a " +
"suitable XMLReader to support " + this);
}
try {
return jaxpfactory.newSAXParser().getXMLReader();
} catch (SAXException e) {
throw new JDOMException(
"Unable to create a new XMLReader instance", e);
} catch (ParserConfigurationException e) {
throw new JDOMException(
"Unable to create a new XMLReader instance", e);
}
}
@Override
public boolean isValidating() {
return validates;
}
}