Package com.helger.xml

Class XMLFactory

java.lang.Object

com.helger.xml.XMLFactory

public final class XMLFactory
extends Object

Utility class for creating XML DOM documents.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_DOM_COALESCING	DocumentBuilderFactory is by default coalescing
static final boolean	DEFAULT_DOM_EXPAND_ENTITY_REFERENCES	DocumentBuilderFactory is by default entity reference expanding
static final boolean	DEFAULT_DOM_IGNORING_COMMENTS	DocumentBuilderFactory is by default ignoring comments
static final boolean	DEFAULT_DOM_IGNORING_ELEMENT_CONTENT_WHITESPACE	DocumentBuilderFactory is by default not ignoring element content whitespace
static final boolean	DEFAULT_DOM_NAMESPACE_AWARE	DocumentBuilderFactory is by default not namespace aware
static final boolean	DEFAULT_DOM_VALIDATING	DocumentBuilderFactory is by default not DTD validating
static final boolean	DEFAULT_DOM_XINCLUDE_AWARE	DocumentBuilderFactory is by default not XInclude aware
static final boolean	DEFAULT_SAX_NAMESPACE_AWARE	SAXParserFactory is by default not namespace aware
static final boolean	DEFAULT_SAX_VALIDATING	SAXParserFactory is by default not DTD validating
static final boolean	DEFAULT_SAX_XINCLUDE_AWARE	SAXParserFactory is by default not XInclude aware

Method Summary

Modifier and Type	Method	Description
static DocumentBuilderFactory	createDefaultDocumentBuilderFactory()	Create a new DocumentBuilderFactory using the defaults defined in this class (DEFAULT_DOM_NAMESPACE_AWARE, DEFAULT_DOM_VALIDATING , DEFAULT_DOM_IGNORING_ELEMENT_CONTENT_WHITESPACE, DEFAULT_DOM_EXPAND_ENTITY_REFERENCES, DEFAULT_DOM_IGNORING_COMMENTS and DEFAULT_DOM_COALESCING.).
static SAXParserFactory	createDefaultSAXParserFactory()
static TransformerFactory	createDefaultTransformerFactory()
static DocumentBuilder	createDocumentBuilder()	Create a document builder without a certain schema, using the default DocumentBuilderFactory.
static DocumentBuilder	createDocumentBuilder(DocumentBuilderFactory aDocBuilderFactory)	Create a document builder without a certain schema, using the passed DocumentBuilderFactory.
static DocumentBuilder	createDocumentBuilder(Schema aSchema)	Create a document builder for a certain schema.
static DocumentBuilderFactory	createDocumentBuilderFactory(Schema aSchema)	Create a new DocumentBuilderFactory for the specified schema, with the following settings: coalescing, comment ignoring and namespace aware.
static void	defaultCustomizeDocumentBuilderFactory(DocumentBuilderFactory aFactory)
static void	defaultCustomizeSAXParserFactory(SAXParserFactory aFactory)
static void	defaultCustomizeTransformerFactory(TransformerFactory aFactory)
static DocumentBuilder	getDocumentBuilder()
static DocumentBuilderFactory	getDocumentBuilderFactory()
static DOMImplementation	getDOMImplementation()
static Document	newDocument()	Create a new XML document without document type using version EXMLVersion.XML_10.
static Document	newDocument(EXMLVersion eVersion)	Create a new XML document without document type using the default document builder.
static Document	newDocument(EXMLVersion eVersion, String sQualifiedName, String sPublicId, String sSystemId)	Create a new document with a document type using the default document builder.
static Document	newDocument(String sQualifiedName, String sPublicId, String sSystemId)	Create a new document with a document type using version EXMLVersion.XML_10.
static Document	newDocument(DocumentBuilder aDocBuilder)	Create a new XML document without document type using version EXMLVersion.XML_10.
static Document	newDocument(DocumentBuilder aDocBuilder, EXMLVersion eVersion)	Create a new XML document without document type using a custom document builder.
static Document	newDocument(DocumentBuilder aDocBuilder, EXMLVersion eVersion, String sQualifiedName, String sPublicId, String sSystemId)	Create a new document with a document type using a custom document builder.
static void	reinitialize()	Reinitialize the document builder factory.
static void	setFeature(DocumentBuilderFactory aFactory, EXMLParserFeature eFeature, boolean bValue)
static void	setFeature(SAXParserFactory aFactory, EXMLParserFeature eFeature, boolean bValue)
static void	setFeature(TransformerFactory aFactory, EXMLParserFeature eFeature, boolean bValue, boolean bLogOnError)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_DOM_NAMESPACE_AWARE

public static final boolean DEFAULT_DOM_NAMESPACE_AWARE

DocumentBuilderFactory is by default not namespace aware

See Also:

• Constant Field Values

DEFAULT_DOM_VALIDATING

public static final boolean DEFAULT_DOM_VALIDATING

DocumentBuilderFactory is by default not DTD validating

See Also:

• Constant Field Values

DEFAULT_DOM_IGNORING_ELEMENT_CONTENT_WHITESPACE

public static final boolean DEFAULT_DOM_IGNORING_ELEMENT_CONTENT_WHITESPACE

DocumentBuilderFactory is by default not ignoring element content whitespace

See Also:

• Constant Field Values

DEFAULT_DOM_EXPAND_ENTITY_REFERENCES

public static final boolean DEFAULT_DOM_EXPAND_ENTITY_REFERENCES

DocumentBuilderFactory is by default entity reference expanding

See Also:

• Constant Field Values

DEFAULT_DOM_IGNORING_COMMENTS

public static final boolean DEFAULT_DOM_IGNORING_COMMENTS

DocumentBuilderFactory is by default ignoring comments

See Also:

• Constant Field Values

DEFAULT_DOM_COALESCING

public static final boolean DEFAULT_DOM_COALESCING

DocumentBuilderFactory is by default coalescing

See Also:

• Constant Field Values

DEFAULT_DOM_XINCLUDE_AWARE

public static final boolean DEFAULT_DOM_XINCLUDE_AWARE

DocumentBuilderFactory is by default not XInclude aware

See Also:

• Constant Field Values

DEFAULT_SAX_NAMESPACE_AWARE

public static final boolean DEFAULT_SAX_NAMESPACE_AWARE

SAXParserFactory is by default not namespace aware

See Also:

• Constant Field Values

DEFAULT_SAX_VALIDATING

public static final boolean DEFAULT_SAX_VALIDATING

SAXParserFactory is by default not DTD validating

See Also:

• Constant Field Values

DEFAULT_SAX_XINCLUDE_AWARE

public static final boolean DEFAULT_SAX_XINCLUDE_AWARE

SAXParserFactory is by default not XInclude aware

See Also:

• Constant Field Values

Method Details

reinitialize

public static void reinitialize()

Reinitialize the document builder factory. This may be necessary if the system properties change!

setFeature

public static void setFeature(@Nonnull
 DocumentBuilderFactory aFactory,
 @Nonnull
 EXMLParserFeature eFeature,
 boolean bValue)

defaultCustomizeDocumentBuilderFactory

public static void defaultCustomizeDocumentBuilderFactory(@Nonnull
 DocumentBuilderFactory aFactory)

createDefaultDocumentBuilderFactory

@Nonnull
public static DocumentBuilderFactory createDefaultDocumentBuilderFactory()

Create a new DocumentBuilderFactory using the defaults defined in this class (DEFAULT_DOM_NAMESPACE_AWARE, DEFAULT_DOM_VALIDATING , DEFAULT_DOM_IGNORING_ELEMENT_CONTENT_WHITESPACE, DEFAULT_DOM_EXPAND_ENTITY_REFERENCES, DEFAULT_DOM_IGNORING_COMMENTS and DEFAULT_DOM_COALESCING.).

Returns:

Never null.

createDocumentBuilderFactory

@Nonnull
public static DocumentBuilderFactory createDocumentBuilderFactory(@Nonnull
 Schema aSchema)

Create a new DocumentBuilderFactory for the specified schema, with the following settings: coalescing, comment ignoring and namespace aware.

Parameters:

aSchema - The schema to use. May not be null.

Returns:

Never null.

getDocumentBuilderFactory

@Nonnull
public static DocumentBuilderFactory getDocumentBuilderFactory()

Returns:

The default document builder factory that is not schema specific. Never null.

getDocumentBuilder

@Nonnull
public static DocumentBuilder getDocumentBuilder()

Returns:

The default document builder that is not schema specific. Never null.

getDOMImplementation

@Nonnull
public static DOMImplementation getDOMImplementation()

Returns:

The DOM implementation of the default document builder. Never null.

createDocumentBuilder

@Nonnull
public static DocumentBuilder createDocumentBuilder()

Create a document builder without a certain schema, using the default DocumentBuilderFactory.

Returns:

The created document builder. Never null.

createDocumentBuilder

@Nonnull
public static DocumentBuilder createDocumentBuilder(@Nonnull
 Schema aSchema)

Create a document builder for a certain schema.

Parameters:

aSchema - The schema to use. May not be null.

Returns:

The created document builder. Never null.

createDocumentBuilder

@Nonnull
public static DocumentBuilder createDocumentBuilder(@Nonnull
 DocumentBuilderFactory aDocBuilderFactory)

Create a document builder without a certain schema, using the passed DocumentBuilderFactory.

Parameters:

aDocBuilderFactory - The document builder factory to be used. May not be null.

Returns:

The created document builder. Never null.

Throws:

com.helger.commons.exception.InitializationException - In case some DOM initialization goes wrong

newDocument

@Nonnull
public static Document newDocument()

Create a new XML document without document type using version EXMLVersion.XML_10. The default document builder is used.

Returns:

The created document. Never null.

newDocument

@Nonnull
public static Document newDocument(@Nonnull
 DocumentBuilder aDocBuilder)

Create a new XML document without document type using version EXMLVersion.XML_10. A custom document builder is used.

Parameters:

aDocBuilder - The document builder to use. May not be null.

Returns:

The created document. Never null.

newDocument

@Nonnull
public static Document newDocument(@Nullable
 EXMLVersion eVersion)

Create a new XML document without document type using the default document builder.

Parameters:

eVersion - The XML version to use. If null is passed, EXMLVersion.XML_10 will be used.

Returns:

The created document. Never null.

newDocument

@Nonnull
public static Document newDocument(@Nonnull
 DocumentBuilder aDocBuilder,
 @Nullable
 EXMLVersion eVersion)

Create a new XML document without document type using a custom document builder.

Parameters:

aDocBuilder - The document builder to use. May not be null.

eVersion - The XML version to use. If null is passed, EXMLVersion.XML_10 will be used.

Returns:

The created document. Never null.

newDocument

@Nonnull
public static Document newDocument(@Nonnull
 String sQualifiedName,
 @Nullable
 String sPublicId,
 @Nullable
 String sSystemId)

Create a new document with a document type using version EXMLVersion.XML_10.

Parameters:

sQualifiedName - The qualified name to use.

sPublicId - The public ID of the document type.

sSystemId - The system ID of the document type.

Returns:

The created document. Never null.

newDocument

@Nonnull
public static Document newDocument(@Nullable
 EXMLVersion eVersion,
 @Nonnull
 String sQualifiedName,
 @Nullable
 String sPublicId,
 @Nullable
 String sSystemId)

Create a new document with a document type using the default document builder.

Parameters:

eVersion - The XML version to use. If null is passed, EXMLVersion.XML_10 will be used.

sQualifiedName - The qualified name to use.

sPublicId - The public ID of the document type.

sSystemId - The system ID of the document type.

Returns:

The created document. Never null.

newDocument

@Nonnull
public static Document newDocument(@Nonnull
 DocumentBuilder aDocBuilder,
 @Nullable
 EXMLVersion eVersion,
 @Nonnull
 String sQualifiedName,
 @Nullable
 String sPublicId,
 @Nullable
 String sSystemId)

Create a new document with a document type using a custom document builder.

Parameters:

aDocBuilder - the document builder to be used. May not be null.

eVersion - The XML version to use. If null is passed, EXMLVersion.XML_10 will be used.

sQualifiedName - The qualified name to use.

sPublicId - The public ID of the document type.

sSystemId - The system ID of the document type.

Returns:

The created document. Never null.

setFeature

public static void setFeature(@Nonnull
 SAXParserFactory aFactory,
 @Nonnull
 EXMLParserFeature eFeature,
 boolean bValue)

defaultCustomizeSAXParserFactory

public static void defaultCustomizeSAXParserFactory(@Nonnull
 SAXParserFactory aFactory)

createDefaultSAXParserFactory

@Nonnull
public static SAXParserFactory createDefaultSAXParserFactory()

setFeature

public static void setFeature(@Nonnull
 TransformerFactory aFactory,
 @Nonnull
 EXMLParserFeature eFeature,
 boolean bValue,
 boolean bLogOnError)

defaultCustomizeTransformerFactory

public static void defaultCustomizeTransformerFactory(@Nonnull
 TransformerFactory aFactory)

createDefaultTransformerFactory

@Nonnull
public static TransformerFactory createDefaultTransformerFactory()