org.bremersee.xml

Interface XmlDocumentBuilder

public interface XmlDocumentBuilder

The xml document builder wraps the functionality of DocumentBuilderFactory. Checked exceptions will be wrapped into XmlRuntimeException.

Author:

Christian Bremer

Method Summary

Modifier and Type	Method and Description
Document	buildDocument() Builds an empty document.
Document	buildDocument(File file) Builds document from file.
Document	buildDocument(InputSource is) Builds document from input source.
Document	buildDocument(InputStream is) Builds document from input stream.
Document	buildDocument(InputStream is, String systemId) Builds document from input stream and system ID.
Document	buildDocument(Object jaxbElement, JAXBContext jaxbContext) Builds document from an object (POJO that can be processed with JAXBContext.
Document	buildDocument(Object jaxbElement, Marshaller marshaller) Builds document from an object (POJO) that can be processed with Marshaller.
Document	buildDocument(String uri) Builds document from uri.
DocumentBuilder	buildDocumentBuilder() Creates a new document builder.
static XmlDocumentBuilder	builder() Creates default builder instance.
XmlDocumentBuilder	configureEntityResolver(EntityResolver entityResolver) Sets the entity resolver to the created DocumentBuilder.
XmlDocumentBuilder	configureErrorHandler(ErrorHandler errorHandler) Sets error handler to the created DocumentBuilder.
XmlDocumentBuilder	configureFactory(Boolean coalescing, Boolean expandEntityReferences, Boolean ignoringComments, Boolean ignoringElementContentWhitespace, Boolean namespaceAware, Boolean validating, Boolean xIncludeAware) Configures the DocumentBuilderFactory.
XmlDocumentBuilder	configureFactory(XmlDocumentBuilderFactoryConfigurator configurator) Configures the DocumentBuilderFactory.
XmlDocumentBuilder	configureFactoryAttribute(String name, Object value) Sets the given attribute to the underlying DocumentBuilderFactory.
XmlDocumentBuilder	configureFactoryFeature(String name, boolean value) Sets the given feature to the underlying DocumentBuilderFactory.
XmlDocumentBuilder	configureFactorySchema(Schema schema) Sets the given schema to the underlying DocumentBuilderFactory.

Method Detail

configureFactory

XmlDocumentBuilder configureFactory(XmlDocumentBuilderFactoryConfigurator configurator)

Configures the DocumentBuilderFactory. The default xml document builder has the same default values as the underlying factory except that DocumentBuilderFactory.setNamespaceAware(boolean) is set to true.

Parameters:

configurator - the configurator

Returns:

the xml document builder

configureFactory

XmlDocumentBuilder configureFactory(Boolean coalescing,
                                    Boolean expandEntityReferences,
                                    Boolean ignoringComments,
                                    Boolean ignoringElementContentWhitespace,
                                    Boolean namespaceAware,
                                    Boolean validating,
                                    Boolean xIncludeAware)

Configures the DocumentBuilderFactory. The default xml document builder has the same default values as the underlying factory except that DocumentBuilderFactory.setNamespaceAware(boolean) is set to true.

A value with null will be ignored and the default will be used.

The default values are:

 coalescing                       = false
 expandEntityReferences           = true
 ignoringComments                 = false
 ignoringElementContentWhitespace = false
 namespaceAware                   = true
 validating                       = false
 xIncludeAware                    = false
 

Parameters:

coalescing - the coalescing

expandEntityReferences - the expand entity references

ignoringComments - the ignoring comments

ignoringElementContentWhitespace - the ignoring element content whitespace

namespaceAware - the namespace aware

validating - the validating

xIncludeAware - the x include aware

Returns:

the xml document builder

configureFactoryAttribute

XmlDocumentBuilder configureFactoryAttribute(String name,
                                             Object value)

Sets the given attribute to the underlying DocumentBuilderFactory.

Parameters:

name - the name

value - the value

Returns:

the xml document builder

See Also:

DocumentBuilderFactory.setAttribute(String, Object)

configureFactoryFeature

XmlDocumentBuilder configureFactoryFeature(String name,
                                           boolean value)

Sets the given feature to the underlying DocumentBuilderFactory.

Parameters:

name - the name

value - the value

Returns:

the xml document builder

See Also:

DocumentBuilderFactory.setFeature(String, boolean)

configureFactorySchema

XmlDocumentBuilder configureFactorySchema(Schema schema)

Sets the given schema to the underlying DocumentBuilderFactory.

Parameters:

schema - the schema

Returns:

the xml document builder

See Also:

DocumentBuilderFactory.setSchema(Schema)

configureEntityResolver

XmlDocumentBuilder configureEntityResolver(EntityResolver entityResolver)

Sets the entity resolver to the created DocumentBuilder.

Parameters:

entityResolver - the entity resolver

Returns:

the xml document builder

See Also:

DocumentBuilder.setEntityResolver(EntityResolver)

configureErrorHandler

XmlDocumentBuilder configureErrorHandler(ErrorHandler errorHandler)

Sets error handler to the created DocumentBuilder.

Parameters:

errorHandler - the error handler

Returns:

the xml document builder

See Also:

DocumentBuilder.setErrorHandler(ErrorHandler)

buildDocumentBuilder

DocumentBuilder buildDocumentBuilder()

Creates a new document builder.

Returns:

the document builder

buildDocument

Document buildDocument()

Builds an empty document.

Returns:

the document

buildDocument

Document buildDocument(File file)

Builds document from file.

Parameters:

file - the file

Returns:

the document

buildDocument

Document buildDocument(String uri)

Builds document from uri.

Parameters:

uri - the uri

Returns:

the document

buildDocument

Document buildDocument(InputSource is)

Builds document from input source.

Parameters:

is - the input source

Returns:

the document

buildDocument

Document buildDocument(InputStream is)

Builds document from input stream.

Parameters:

is - the input stream

Returns:

the document

buildDocument

Document buildDocument(InputStream is,
                       String systemId)

Builds document from input stream and system ID.

Parameters:

is - the input stream

systemId - the system id

Returns:

the document

buildDocument

Document buildDocument(Object jaxbElement,
                       JAXBContext jaxbContext)

Builds document from an object (POJO that can be processed with JAXBContext.

Parameters:

jaxbElement - the jaxb element

jaxbContext - the jaxb context

Returns:

the document

buildDocument

Document buildDocument(Object jaxbElement,
                       Marshaller marshaller)

Builds document from an object (POJO) that can be processed with Marshaller.

Parameters:

jaxbElement - the jaxb element

marshaller - the marshaller

Returns:

the document

builder

static XmlDocumentBuilder builder()

Creates default builder instance.

Returns:

the default builder instance