com.phloc.commons.xml

Enum EXMLParserFeature

java.lang.Object

java.lang.Enum<EXMLParserFeature>

com.phloc.commons.xml.EXMLParserFeature

All Implemented Interfaces:

IHasName, Serializable, Comparable<EXMLParserFeature>

public enum EXMLParserFeature
extends Enum<EXMLParserFeature>
implements IHasName

Contains constants for parser features.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUGMENT_PSVI When set: Augment Post-Schema-Validation-Infoset.
BALANCE_SYNTAX_TREES When set: Construct an optimal representation for DTD content models to significantly reduce the likelihood a StackOverflowError will occur when large content models are processed.
DYNAMIC When set: The parser will validate the document only if a grammar is specified.
ELEMENT_DEFAULT When set: Send XML Schema element default values via characters().
EXTERNAL_GENERAL_ENTITIES When set: Include external general entities.
EXTERNAL_PARAMETER_ENTITIES When set: Include external parameter entities and the external DTD subset.
GENERATE_SYNTHETIC_ANNOTATIONS When set: Enable generation of synthetic annotations.
HONOUR_ALL_SCHEMA_LOCATIONS When set: All schema location hints will be used to locate the components for a given target namespace.
ID_IDREF_CHECKING When set: Enable checking of ID/IDREF constraints.
IDENTITY_CONSTRAINT_CHECKING When set: Enable identity constraint checking.
IGNORE_XSI_TYPE_UNTIL_ELEMDECL When set: xsi:type attributes will be ignored until a global element declaration has been found, at which point xsi:type attributes will be processed on the element for which the global element declaration was found as well as its descendants.
NAMESPACES When set: Perform namespace processing: prefixes will be stripped off element and attribute names and replaced with the corresponding namespace URIs.
NORMALIZED_VALUE When set: Expose via SAX and DOM XML Schema normalized values for attributes and elements.
SAX_FEATURE_IS_STANDALONE When set: The document specified standalone="yes" in its XML declaration.
SAX_IS_XML11_PARSER When set: The parser supports both XML 1.0 and XML 1.1.
SAX_NAMESPACE_PREFIXES Namespace prefixes feature id (http://xml.org/sax/features/namespace-prefixes).
SAX_USE_ATTRIBUTES2 When set: The Attributes objects passed by the parser in org.xml.sax.ContentHandler.startElement() implement the org.xml.sax.ext.Attributes2 interface.
SAX_USE_LOCATOR2 When set: The Locator objects passed by the parser in org.xml.sax.ContentHandler.setDocumentLocator() implement the org.xml.sax.ext.Locator2 interface.
SCHEMA When set: Turn on XML Schema validation by inserting an XML Schema validator into the pipeline.
SCHEMA_FULL_CHECKING When set: Enable full schema grammar constraint checking, including checking which may be time-consuming or memory intensive.
UNPARSED_ENTITY_CHECKING When set: Check that each value of type ENTITY matches the name of an unparsed entity declared in the DTD.
USE_ENTITY_RESOLVER2 When set: The methods of the org.xml.sax.ext.EntityResolver2 interface will be used when an object implementing this interface is registered with the parser using setEntityResolver.
VALIDATE_ANNOTATIONS When set: Schema annotations will be laxly validated against available schema components.
VALIDATION When set: Validate the document and report validity errors.
WARN_ON_DUPLICATE_ATTDEF When set: Report a warning when a duplicate attribute is re-declared.
WARN_ON_DUPLICATE_ENTITYDEF When set: Report a warning for duplicate entity declaration.
WARN_ON_UNDECLARED_ELEMDEF When set: Report a warning if an element referenced in a content model is not declared.
XINCLUDE When set: Enable XInclude processing.
XINCLUDE_FIXUP_BASE_URIS When set: Perform base URI fixup as specified by the XInclude Recommendation.
XINCLUDE_FIXUP_LANGUAGE When set: Perform language fixup as specified by the XInclude Recommendation.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyTo(DocumentBuilderFactory aDocumentBuilderFactory, boolean bValue)
void	applyTo(XMLReader aParser, boolean bValue)
static List<EXMLParserFeature>	getAllFeaturesOfType(EXMLParserFeatureType eFeatureType)
EXMLParserFeatureType	getFeatureType()
static EXMLParserFeature	getFromNameOrNull(String sName)
String	getName()
static EXMLParserFeature	valueOf(String name) Returns the enum constant of this type with the specified name.
static EXMLParserFeature[]	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

NAMESPACES

public static final EXMLParserFeature NAMESPACES

When set: Perform namespace processing: prefixes will be stripped off element and attribute names and replaced with the corresponding namespace URIs. By default, the two will simply be concatenated, but the namespace-sep core property allows the application to specify a delimiter string for separating the URI part and the local part (http://xml.org/sax/features/namespaces).

USE_ENTITY_RESOLVER2

public static final EXMLParserFeature USE_ENTITY_RESOLVER2

When set: The methods of the org.xml.sax.ext.EntityResolver2 interface will be used when an object implementing this interface is registered with the parser using setEntityResolver. (http://xml.org/sax/features/namespaces).

VALIDATION

public static final EXMLParserFeature VALIDATION

When set: Validate the document and report validity errors. (http://xml.org/sax/features/validation). Default: false

DYNAMIC

public static final EXMLParserFeature DYNAMIC

When set: The parser will validate the document only if a grammar is specified. (http://apache.org/xml/features/validation/dynamic).

SCHEMA

public static final EXMLParserFeature SCHEMA

When set: Turn on XML Schema validation by inserting an XML Schema validator into the pipeline. (http://apache.org/xml/features/validation/schema). Default: false

SCHEMA_FULL_CHECKING

public static final EXMLParserFeature SCHEMA_FULL_CHECKING

When set: Enable full schema grammar constraint checking, including checking which may be time-consuming or memory intensive. Currently, unique particle attribution constraint checking and particle derivation restriction checking are controlled by this option. (http://apache.org/xml/features/validation/schema-full-checking). Default: false

NORMALIZED_VALUE

public static final EXMLParserFeature NORMALIZED_VALUE

When set: Expose via SAX and DOM XML Schema normalized values for attributes and elements. (http://apache.org/xml/features/validation/schema/normalized-value).

ELEMENT_DEFAULT

public static final EXMLParserFeature ELEMENT_DEFAULT

When set: Send XML Schema element default values via characters(). (http://apache.org/xml/features/validation/schema/element-default).

AUGMENT_PSVI

public static final EXMLParserFeature AUGMENT_PSVI

When set: Augment Post-Schema-Validation-Infoset. (http://apache.org/xml/features/validation/schema/augment-psvi).

IGNORE_XSI_TYPE_UNTIL_ELEMDECL

public static final EXMLParserFeature IGNORE_XSI_TYPE_UNTIL_ELEMDECL

When set: xsi:type attributes will be ignored until a global element declaration has been found, at which point xsi:type attributes will be processed on the element for which the global element declaration was found as well as its descendants. (http://apache.org/xml/features/validation/schema /ignore-xsi-type-until-elemdecl).

GENERATE_SYNTHETIC_ANNOTATIONS

public static final EXMLParserFeature GENERATE_SYNTHETIC_ANNOTATIONS

When set: Enable generation of synthetic annotations. A synthetic annotation will be generated when a schema component has non-schema attributes but no child annotation. (http://apache.org/xml/features/generate-synthetic-annotations).

VALIDATE_ANNOTATIONS

public static final EXMLParserFeature VALIDATE_ANNOTATIONS

When set: Schema annotations will be laxly validated against available schema components. (http://apache.org/xml/features/validate-annotations).

HONOUR_ALL_SCHEMA_LOCATIONS

public static final EXMLParserFeature HONOUR_ALL_SCHEMA_LOCATIONS

When set: All schema location hints will be used to locate the components for a given target namespace. (http://apache.org/xml/features/honour-all-schemaLocations).

EXTERNAL_GENERAL_ENTITIES

public static final EXMLParserFeature EXTERNAL_GENERAL_ENTITIES

When set: Include external general entities. (http://xml.org/sax/features/external-general-entities).

EXTERNAL_PARAMETER_ENTITIES

public static final EXMLParserFeature EXTERNAL_PARAMETER_ENTITIES

When set: Include external parameter entities and the external DTD subset. (http://xml.org/sax/features/external-parameter-entities).

BALANCE_SYNTAX_TREES

public static final EXMLParserFeature BALANCE_SYNTAX_TREES

When set: Construct an optimal representation for DTD content models to significantly reduce the likelihood a StackOverflowError will occur when large content models are processed. (http://apache.org/xml/features/validation/balance-syntax-trees).

ID_IDREF_CHECKING

public static final EXMLParserFeature ID_IDREF_CHECKING

When set: Enable checking of ID/IDREF constraints. (http://apache.org/xml/features/validation/id-idref-checking).

IDENTITY_CONSTRAINT_CHECKING

public static final EXMLParserFeature IDENTITY_CONSTRAINT_CHECKING

When set: Enable identity constraint checking. (http://apache.org/xml/features/validation/identity-constraint-checking).

UNPARSED_ENTITY_CHECKING

public static final EXMLParserFeature UNPARSED_ENTITY_CHECKING

When set: Check that each value of type ENTITY matches the name of an unparsed entity declared in the DTD. (http://apache.org/xml/features/validation/unparsed-entity-checking).

WARN_ON_DUPLICATE_ATTDEF

public static final EXMLParserFeature WARN_ON_DUPLICATE_ATTDEF

When set: Report a warning when a duplicate attribute is re-declared. (http://apache.org/xml/features/validation/warn-on-duplicate-attdef).

WARN_ON_UNDECLARED_ELEMDEF

public static final EXMLParserFeature WARN_ON_UNDECLARED_ELEMDEF

When set: Report a warning if an element referenced in a content model is not declared. (http://apache.org/xml/features/validation/warn-on-undeclared-elemdef).

WARN_ON_DUPLICATE_ENTITYDEF

public static final EXMLParserFeature WARN_ON_DUPLICATE_ENTITYDEF

When set: Report a warning for duplicate entity declaration. (http://apache.org/xml/features/warn-on-duplicate-entitydef).

XINCLUDE

public static final EXMLParserFeature XINCLUDE

When set: Enable XInclude processing. (http://apache.org/xml/features/xinclude).

XINCLUDE_FIXUP_BASE_URIS

public static final EXMLParserFeature XINCLUDE_FIXUP_BASE_URIS

When set: Perform base URI fixup as specified by the XInclude Recommendation. (http://apache.org/xml/features/xinclude/fixup-base-uris).

XINCLUDE_FIXUP_LANGUAGE

public static final EXMLParserFeature XINCLUDE_FIXUP_LANGUAGE

When set: Perform language fixup as specified by the XInclude Recommendation. (http://apache.org/xml/features/xinclude/fixup-language).

SAX_NAMESPACE_PREFIXES

public static final EXMLParserFeature SAX_NAMESPACE_PREFIXES

Namespace prefixes feature id (http://xml.org/sax/features/namespace-prefixes).

SAX_FEATURE_IS_STANDALONE

public static final EXMLParserFeature SAX_FEATURE_IS_STANDALONE

When set: The document specified standalone="yes" in its XML declaration.
Read-only! (http://xml.org/sax/features/is-standalone)

SAX_USE_ATTRIBUTES2

public static final EXMLParserFeature SAX_USE_ATTRIBUTES2

When set: The Attributes objects passed by the parser in org.xml.sax.ContentHandler.startElement() implement the org.xml.sax.ext.Attributes2 interface. (http://xml.org/sax/features/use-attributes2).

SAX_USE_LOCATOR2

public static final EXMLParserFeature SAX_USE_LOCATOR2

When set: The Locator objects passed by the parser in org.xml.sax.ContentHandler.setDocumentLocator() implement the org.xml.sax.ext.Locator2 interface. (http://xml.org/sax/features/use-locator2).

SAX_IS_XML11_PARSER

public static final EXMLParserFeature SAX_IS_XML11_PARSER

When set: The parser supports both XML 1.0 and XML 1.1.
Read-only! (http://xml.org/sax/features/xml-1.1)

Method Detail

values

public static EXMLParserFeature[] 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 (EXMLParserFeature c : EXMLParserFeature.values())
    System.out.println(c);

Returns:

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

valueOf

public static EXMLParserFeature valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getFeatureType

@Nonnull
public EXMLParserFeatureType getFeatureType()

getName

@Nonnull
@Nonempty
public String getName()

Specified by:

getName in interface IHasName

Returns:

The name of the object. May not be null.

applyTo

public void applyTo(@Nonnull
           XMLReader aParser,
           boolean bValue)

applyTo

public void applyTo(@Nonnull
           DocumentBuilderFactory aDocumentBuilderFactory,
           boolean bValue)

getFromNameOrNull

@Nullable
public static EXMLParserFeature getFromNameOrNull(@Nullable
                                           String sName)

getAllFeaturesOfType

@Nonnull
@ReturnsMutableCopy
public static List<EXMLParserFeature> getAllFeaturesOfType(@Nonnull
                                                                      EXMLParserFeatureType eFeatureType)