JDOM
2.0.5

org.jdom2.input.sax
Enum XMLReaders

java.lang.Object
  extended by java.lang.Enum<XMLReaders>
      extended by org.jdom2.input.sax.XMLReaders
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<XMLReaders>, XMLReaderJDOMFactory

public enum XMLReaders
extends java.lang.Enum<XMLReaders>
implements XMLReaderJDOMFactory

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

Enum Constant Summary
DTDVALIDATING
          The DTD-validating Singleton
NONVALIDATING
          The non-validating singleton
XSDVALIDATING
          The XSD-validating Singleton
 
Method Summary
 org.xml.sax.XMLReader createXMLReader()
          Get a new XMLReader from this JAXP-based XMLReaderJDOMFactory.
 boolean isValidating()
          Does an XMLReader from this factory do more than just well-formed checks.
static XMLReaders valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static XMLReaders[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NONVALIDATING

public static final XMLReaders NONVALIDATING
The non-validating singleton


DTDVALIDATING

public static final XMLReaders DTDVALIDATING
The DTD-validating Singleton


XSDVALIDATING

public static final XMLReaders XSDVALIDATING
The XSD-validating Singleton

Method Detail

values

public static XMLReaders[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (XMLReaders c : XMLReaders.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static XMLReaders valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

createXMLReader

public org.xml.sax.XMLReader createXMLReader()
                                      throws JDOMException
Get a new XMLReader from this JAXP-based XMLReaderJDOMFactory.

Specified by:
createXMLReader in interface XMLReaderJDOMFactory
Returns:
a new XMLReader instance.
Throws:
JDOMException - if there is a problem creating the XMLReader

isValidating

public boolean isValidating()
Description copied from interface: XMLReaderJDOMFactory
Does an XMLReader from this factory do more than just well-formed checks.

Specified by:
isValidating in interface XMLReaderJDOMFactory
Returns:
true if the XMLReader validates

JDOM
2.0.5

Copyright 2013 Jason Hunter, Brett McLaughlin. All Rights Reserved.