org.apache.axiom.om

Class OMXMLBuilderFactory

java.lang.Object

org.apache.axiom.om.OMXMLBuilderFactory

public class OMXMLBuilderFactory
extends Object

Provides static factory methods to create various kinds of object model builders from different types of input sources. The methods defined by this class are the starting point to parse XML documents into Axiom trees.

Method Summary

Modifier and Type	Method and Description
static OMXMLParserWrapper	createOMBuilder(InputStream in) Create an object model builder that reads a plain XML document from the provided input stream with the default parser configuration defined by StAXParserConfiguration.DEFAULT.
static OMXMLParserWrapper	createOMBuilder(OMFactory omFactory, InputStream in) Create an object model builder that reads an XML document from the provided input stream using a specified object model factory and with the default parser configuration defined by StAXParserConfiguration.DEFAULT.
static OMXMLParserWrapper	createOMBuilder(OMFactory omFactory, Reader in) Create an object model builder that reads an XML document from the provided character stream using a specified object model factory and with the default parser configuration defined by StAXParserConfiguration.DEFAULT.
static OMXMLParserWrapper	createOMBuilder(OMFactory omFactory, StAXParserConfiguration configuration, InputStream in) Create an object model builder that reads an XML document from the provided input stream using a specified object model factory and with a given parser configuration.
static OMXMLParserWrapper	createOMBuilder(OMFactory omFactory, StAXParserConfiguration configuration, Reader in) Create an object model builder that reads an XML document from the provided character stream using a specified object model factory and with a given parser configuration.
static OMXMLParserWrapper	createOMBuilder(Reader in) Create an object model builder that reads a plain XML document from the provided character stream with the default parser configuration defined by StAXParserConfiguration.DEFAULT.
static OMXMLParserWrapper	createOMBuilder(StAXParserConfiguration configuration, InputStream in) Create an object model builder that reads a plain XML document from the provided input stream with a given parser configuration.
static OMXMLParserWrapper	createOMBuilder(StAXParserConfiguration configuration, Reader in) Create an object model builder that reads a plain XML document from the provided character stream with a given parser configuration.
static OMXMLParserWrapper	createSOAPModelBuilder(InputStream in, String encoding) Create an object model builder for SOAP that reads a message from the provided input stream, using a given charset encoding.
static OMXMLParserWrapper	createStAXOMBuilder(OMFactory omFactory, XMLStreamReader parser) Create an object model builder that pulls events from a StAX stream reader using a specified object model factory.
static OMXMLParserWrapper	createStAXOMBuilder(XMLStreamReader parser) Create an object model builder for plain XML that pulls events from a StAX stream reader.

Methods inherited from class java.lang.Object

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

Method Detail

createStAXOMBuilder

public static OMXMLParserWrapper createStAXOMBuilder(XMLStreamReader parser)

Create an object model builder for plain XML that pulls events from a StAX stream reader.

Parameters:

parser - the stream reader to read the XML data from

Returns:

the builder

createStAXOMBuilder

public static OMXMLParserWrapper createStAXOMBuilder(OMFactory omFactory,
                                                     XMLStreamReader parser)

Create an object model builder that pulls events from a StAX stream reader using a specified object model factory.

Parameters:

omFactory - the object model factory to use

parser - the stream reader to read the XML data from

Returns:

the builder

createOMBuilder

public static OMXMLParserWrapper createOMBuilder(InputStream in)

Create an object model builder that reads a plain XML document from the provided input stream with the default parser configuration defined by StAXParserConfiguration.DEFAULT.

Parameters:

in - the input stream representing the XML document

Returns:

the builder

createOMBuilder

public static OMXMLParserWrapper createOMBuilder(StAXParserConfiguration configuration,
                                                 InputStream in)

Create an object model builder that reads a plain XML document from the provided input stream with a given parser configuration.

Parameters:

configuration - the parser configuration to use

in - the input stream representing the XML document

Returns:

the builder

createOMBuilder

public static OMXMLParserWrapper createOMBuilder(OMFactory omFactory,
                                                 InputStream in)

Create an object model builder that reads an XML document from the provided input stream using a specified object model factory and with the default parser configuration defined by StAXParserConfiguration.DEFAULT.

Parameters:

omFactory - the object model factory to use

in - the input stream representing the XML document

Returns:

the builder

createOMBuilder

public static OMXMLParserWrapper createOMBuilder(OMFactory omFactory,
                                                 StAXParserConfiguration configuration,
                                                 InputStream in)

Create an object model builder that reads an XML document from the provided input stream using a specified object model factory and with a given parser configuration.

Parameters:

omFactory - the object model factory to use

configuration - the parser configuration to use

in - the input stream representing the XML document

Returns:

the builder

createOMBuilder

public static OMXMLParserWrapper createOMBuilder(Reader in)

Create an object model builder that reads a plain XML document from the provided character stream with the default parser configuration defined by StAXParserConfiguration.DEFAULT.

Parameters:

in - the character stream representing the XML document

Returns:

the builder

createOMBuilder

public static OMXMLParserWrapper createOMBuilder(StAXParserConfiguration configuration,
                                                 Reader in)

Create an object model builder that reads a plain XML document from the provided character stream with a given parser configuration.

Parameters:

configuration - the parser configuration to use

in - the character stream representing the XML document

Returns:

the builder

createOMBuilder

public static OMXMLParserWrapper createOMBuilder(OMFactory omFactory,
                                                 Reader in)

Create an object model builder that reads an XML document from the provided character stream using a specified object model factory and with the default parser configuration defined by StAXParserConfiguration.DEFAULT.

Parameters:

omFactory - the object model factory to use

in - the character stream representing the XML document

Returns:

the builder

createOMBuilder

public static OMXMLParserWrapper createOMBuilder(OMFactory omFactory,
                                                 StAXParserConfiguration configuration,
                                                 Reader in)

Create an object model builder that reads an XML document from the provided character stream using a specified object model factory and with a given parser configuration.

Parameters:

omFactory - the object model factory to use

configuration - the parser configuration to use

in - the character stream representing the XML document

Returns:

the builder

createSOAPModelBuilder

public static OMXMLParserWrapper createSOAPModelBuilder(InputStream in,
                                                        String encoding)

Create an object model builder for SOAP that reads a message from the provided input stream, using a given charset encoding. The method will select the appropriate SOAPFactory based on the namespace URI of the SOAP envelope. It will configure the underlying parser as specified by StAXParserConfiguration.SOAP.

Parameters:

in - the input stream containing the SOAP message

encoding - the charset encoding

Returns:

the builder