Top Description Inners Fields Constructors Methods
org.jdom2.input.sax

public final Enum XMLReaders

extends Enum<XMLReaders>
implements XMLReaderJDOMFactory
Class Inheritance
All Implemented Interfaces
org.jdom2.input.sax.XMLReaderJDOMFactory
Imports
javax.xml.XMLConstants, javax.xml.parsers.ParserConfigurationException, .SAXParserFactory, javax.xml.validation.Schema, .SchemaFactory, org.xml.sax.SAXException, .XMLReader, org.jdom2.JDOMException

An enumeration of 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 package documentation for details of how to create the SAXParser you desire.

Author
Rolf Lear
See Also
org.jdom2.input.sax

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static enum
private static interface
private static enum
private static enum

Field Summary

Modifier and TypeField and Description
public static final XMLReaders
DTDVALIDATING

The DTD-validating Singleton

public static final XMLReaders
NONVALIDATING

The non-validating singleton

private final int
singletonID

the actual SAXParserFactory in the respective singletons.

public static final XMLReaders
XSDVALIDATING

The XSD-validating Singleton

Constructor Summary

AccessConstructor and Description
private
XMLReaders(int singletonID)

Private constructor

Method Summary

Modifier and TypeMethod and Description
public XMLReader

Returns:

a new XMLReader instance.
createXMLReader
()

Implements org.jdom2.input.sax.XMLReaderJDOMFactory.createXMLReader.

Get a new XMLReader from this JAXP-based XMLReaderJDOMFactory.
private XMLReaders.FactorySupplier
public boolean
isValidating()

Implements org.jdom2.input.sax.XMLReaderJDOMFactory.isValidating.

Does an XMLReader from this factory do more than just well-formed checks.
public static XMLReaders
public static XMLReaders[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DTDVALIDATINGback to summary
public static final XMLReaders DTDVALIDATING

The DTD-validating Singleton

NONVALIDATINGback to summary
public static final XMLReaders NONVALIDATING

The non-validating singleton

singletonIDback to summary
private final int singletonID

the actual SAXParserFactory in the respective singletons.

XSDVALIDATINGback to summary
public static final XMLReaders XSDVALIDATING

The XSD-validating Singleton

Constructor Detail

XMLReadersback to summary
private XMLReaders(int singletonID)

Private constructor

Method Detail

createXMLReaderback to summary
public XMLReader createXMLReader() throws JDOMException

Implements org.jdom2.input.sax.XMLReaderJDOMFactory.createXMLReader.

Get a new XMLReader from this JAXP-based XMLReaderJDOMFactory.

Returns:XMLReader

a new XMLReader instance.

Annotations
@Override
Exceptions
JDOMException:
if there is a problem creating the XMLReader
getSupplierback to summary
private XMLReaders.FactorySupplier getSupplier()
isValidatingback to summary
public boolean isValidating()

Implements org.jdom2.input.sax.XMLReaderJDOMFactory.isValidating.

Doc from org.jdom2.input.sax.XMLReaderJDOMFactory.isValidating.

Does an XMLReader from this factory do more than just well-formed checks.

Returns:boolean

true if the XMLReader validates

Annotations
@Override
valueOfback to summary
public static XMLReaders valueOf(String name)
valuesback to summary
public static XMLReaders[] values()
org.jdom2.input.sax back to summary

private final Enum XMLReaders.DTDSingleton

extends Enum<XMLReaders.DTDSingleton>
implements FactorySupplier
Class Inheritance
All Implemented Interfaces
org.jdom2.input.sax.XMLReaders.FactorySupplier

Field Summary

Modifier and TypeField and Description
private final SAXParserFactory
public static final XMLReaders.DTDSingleton

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public SAXParserFactory
public boolean
public static XMLReaders.DTDSingleton
public static XMLReaders.DTDSingleton[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

factoryback to summary
private final SAXParserFactory factory
INSTANCEback to summary
public static final XMLReaders.DTDSingleton INSTANCE

Constructor Detail

DTDSingletonback to summary
private DTDSingleton()

Method Detail

supplyback to summary
public SAXParserFactory supply() throws Exception

Implements org.jdom2.input.sax.XMLReaders.FactorySupplier.supply.

Annotations
@Override
validatesback to summary
public boolean validates()

Implements org.jdom2.input.sax.XMLReaders.FactorySupplier.validates.

Annotations
@Override
valueOfback to summary
public static XMLReaders.DTDSingleton valueOf(String name)
valuesback to summary
public static XMLReaders.DTDSingleton[] values()
org.jdom2.input.sax back to summary

private Interface XMLReaders.FactorySupplier

Known Direct Implementers
org.jdom2.input.sax.XMLReaders.NONSingleton, org.jdom2.input.sax.XMLReaders.DTDSingleton, org.jdom2.input.sax.XMLReaders.XSDSingleton

Method Summary

Modifier and TypeMethod and Description
public SAXParserFactory
public boolean

Method Detail

supplyback to summary
public SAXParserFactory supply() throws Exception
validatesback to summary
public boolean validates()
org.jdom2.input.sax back to summary

private final Enum XMLReaders.NONSingleton

extends Enum<XMLReaders.NONSingleton>
implements FactorySupplier
Class Inheritance
All Implemented Interfaces
org.jdom2.input.sax.XMLReaders.FactorySupplier

Field Summary

Modifier and TypeField and Description
private final SAXParserFactory
public static final XMLReaders.NONSingleton

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public SAXParserFactory
public boolean
public static XMLReaders.NONSingleton
public static XMLReaders.NONSingleton[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

factoryback to summary
private final SAXParserFactory factory
INSTANCEback to summary
public static final XMLReaders.NONSingleton INSTANCE

Constructor Detail

NONSingletonback to summary
private NONSingleton()

Method Detail

supplyback to summary
public SAXParserFactory supply() throws Exception

Implements org.jdom2.input.sax.XMLReaders.FactorySupplier.supply.

Annotations
@Override
validatesback to summary
public boolean validates()

Implements org.jdom2.input.sax.XMLReaders.FactorySupplier.validates.

Annotations
@Override
valueOfback to summary
public static XMLReaders.NONSingleton valueOf(String name)
valuesback to summary
public static XMLReaders.NONSingleton[] values()
org.jdom2.input.sax back to summary

private final Enum XMLReaders.XSDSingleton

extends Enum<XMLReaders.XSDSingleton>
implements FactorySupplier
Class Inheritance
All Implemented Interfaces
org.jdom2.input.sax.XMLReaders.FactorySupplier

Field Summary

Modifier and TypeField and Description
private final SAXParserFactory
private final Exception
public static final XMLReaders.XSDSingleton

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public SAXParserFactory
public boolean
public static XMLReaders.XSDSingleton
public static XMLReaders.XSDSingleton[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

factoryback to summary
private final SAXParserFactory factory
failcauseback to summary
private final Exception failcause
INSTANCEback to summary
public static final XMLReaders.XSDSingleton INSTANCE

Constructor Detail

XSDSingletonback to summary
private XSDSingleton()

Method Detail

supplyback to summary
public SAXParserFactory supply() throws Exception

Implements org.jdom2.input.sax.XMLReaders.FactorySupplier.supply.

Annotations
@Override
validatesback to summary
public boolean validates()

Implements org.jdom2.input.sax.XMLReaders.FactorySupplier.validates.

Annotations
@Override
valueOfback to summary
public static XMLReaders.XSDSingleton valueOf(String name)
valuesback to summary
public static XMLReaders.XSDSingleton[] values()