org.apache.axiom.om.util

Interface StAXWriterConfiguration

public interface StAXWriterConfiguration

Defines a particular StAX writer configuration. An implementation of this interface must satisfy the following requirements:

1. It MUST be immutable.
2. It MUST either be a singleton or properly implement Object.equals(Object) and Object.hashCode().

These two requirements ensure that instances of this interface may be used as cache keys.

See Also:

StAXParserConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static StAXWriterConfiguration	DEFAULT The default configuration.

Method Summary

Modifier and Type	Method and Description
javax.xml.stream.XMLOutputFactory	configure(javax.xml.stream.XMLOutputFactory factory, StAXDialect dialect) Apply the configuration to the given factory.

Field Detail

DEFAULT

static final StAXWriterConfiguration DEFAULT

The default configuration.

Method Detail

configure

javax.xml.stream.XMLOutputFactory configure(javax.xml.stream.XMLOutputFactory factory,
                                            StAXDialect dialect)

Apply the configuration to the given factory. The method MAY optionally wrap the factory.

Parameters:

factory - the factory to configure

dialect - The dialect of the StAX implementation as detected by StAXDialectDetector. The implementation may use this information to configure implementation specific settings.

Returns:

The configured factory. This may be the original factory (if the implementation only changes the factory properties), or a wrapper.