javolution.xml.internal.stream.XMLOutputFactoryImpl Class Reference

Inheritance diagram for javolution.xml.internal.stream.XMLOutputFactoryImpl:

Collaboration diagram for javolution.xml.internal.stream.XMLOutputFactoryImpl:

Public Member Functions
XMLStreamWriterImpl	createXMLStreamWriter (OutputStream stream) throws XMLStreamException
XMLStreamWriterImpl	createXMLStreamWriter (OutputStream stream, String encoding) throws XMLStreamException
XMLStreamWriterImpl	createXMLStreamWriter (Writer writer) throws XMLStreamException
Object	getProperty (String name) throws IllegalArgumentException
boolean	isPropertySupported (String name)
void	setProperty (String name, Object value) throws IllegalArgumentException
XMLOutputFactory	clone ()

Static Public Attributes
static final String	IS_REPAIRING_NAMESPACES = "javolution.xml.stream.isRepairingNamespaces"
static final String	REPAIRING_PREFIX = "javolution.xml.stream.repairingPrefix"
static final String	INDENTATION = "javolution.xml.stream.indentation"
static final String	LINE_SEPARATOR = "javolution.xml.stream.lineSeparator"
static final String	AUTOMATIC_EMPTY_ELEMENTS = "javolution.xml.stream.automaticEmptyElements"
static final String	NO_EMPTY_ELEMENT_TAG = "javolution.xml.stream.noEmptyElementTag"

Package Functions
void	recycle (XMLStreamWriterImpl xmlWriter)

Private Member Functions
XMLStreamWriterImpl	newWriter ()

Private Attributes
Boolean	_automaticEmptyElements = Boolean.FALSE
String	_indentation
Boolean	_isRepairingNamespaces = Boolean.FALSE
String	_lineSeparator = "\n"
Boolean	_noEmptyElementTag = Boolean.FALSE
String	_repairingPrefix = "ns"
FastTable< XMLStreamWriterImpl >	_recycled

Detailed Description

This default XML Output factory implementation.

Definition at line 21 of file XMLOutputFactoryImpl.java.

Member Function Documentation

clone()

XMLOutputFactory javolution.xml.internal.stream.XMLOutputFactoryImpl.clone

(

)

Returns a clone of this factory which can be independently configured.

Implements javolution.xml.stream.XMLOutputFactory.

Definition at line 142 of file XMLOutputFactoryImpl.java.

                                    {
        try {
            XMLOutputFactoryImpl clone = (XMLOutputFactoryImpl) super.clone();
            clone._recycled = new FastTable<XMLStreamWriterImpl>().shared();
            return clone;
        } catch (CloneNotSupportedException e) {
            throw new Error();// Cannot happen since cloneable.
        }
    }

References javolution.xml.stream.XMLOutputFactory.clone(), and javolution.util.FastTable< E >.shared().

Here is the call graph for this function:

createXMLStreamWriter() [1/3]

XMLStreamWriterImpl javolution.xml.internal.stream.XMLOutputFactoryImpl.createXMLStreamWriter

(

OutputStream

stream

)

throws XMLStreamException

Returns a XML stream writer to the specified output stream (UTF-8 encoding).

Parameters

stream

the stream to write to.

Returns

a xml stream writer possibly recycled.

Exceptions

XMLStreamException

Implements javolution.xml.stream.XMLOutputFactory.

Definition at line 45 of file XMLOutputFactoryImpl.java.

                                      {
        XMLStreamWriterImpl xmlWriter = newWriter();
        xmlWriter.setOutput(stream);
        return xmlWriter;
    }

References javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLStreamWriterImpl.setOutput().

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.createXMLStreamWriter().

Here is the call graph for this function:

Here is the caller graph for this function:

createXMLStreamWriter() [2/3]

XMLStreamWriterImpl javolution.xml.internal.stream.XMLOutputFactoryImpl.createXMLStreamWriter	(	OutputStream	stream,
		String	encoding
	)		throws XMLStreamException

Returns a XML stream writer to the specified output stream using the specified encoding.

Parameters

stream	the stream to write to.
encoding	the encoding to use.

Returns

a xml stream writer possibly recycled.

Exceptions

XMLStreamException

Implements javolution.xml.stream.XMLOutputFactory.

Definition at line 53 of file XMLOutputFactoryImpl.java.

                                                       {
        if ((encoding == null) || encoding.equals("UTF-8")
                || encoding.equals("utf-8"))
            return createXMLStreamWriter(stream);
        XMLStreamWriterImpl xmlWriter = newWriter();
        xmlWriter.setOutput(stream, encoding);
        return xmlWriter;
    }

References javolution.xml.internal.stream.XMLOutputFactoryImpl.createXMLStreamWriter(), javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLStreamWriterImpl.setOutput().

Here is the call graph for this function:

createXMLStreamWriter() [3/3]

XMLStreamWriterImpl javolution.xml.internal.stream.XMLOutputFactoryImpl.createXMLStreamWriter

(

Writer

writer

)

throws XMLStreamException

Returns a XML stream writer to the specified i/o writer.

Parameters

writer

the writer to write to.

Returns

a xml stream writer possibly recycled.

Exceptions

XMLStreamException

Implements javolution.xml.stream.XMLOutputFactory.

Definition at line 64 of file XMLOutputFactoryImpl.java.

                                      {
        XMLStreamWriterImpl xmlWriter = newWriter();
        xmlWriter.setOutput(writer);
        return xmlWriter;
    }

References javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLStreamWriterImpl.setOutput().

Here is the call graph for this function:

getProperty()

Object javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty

(

String

name

)

throws IllegalArgumentException

Gets a feature/property on the underlying implementation.

Parameters

name	the name of the property

Returns

the value of the property

Exceptions

IllegalArgumentException

if the property is not supported.

Implements javolution.xml.stream.XMLOutputFactory.

Definition at line 72 of file XMLOutputFactoryImpl.java.

                                                                           {
        if (name.equals(IS_REPAIRING_NAMESPACES)) {
            return _isRepairingNamespaces;
        } else if (name.equals(REPAIRING_PREFIX)) {
            return _repairingPrefix;
        } else if (name.equals(AUTOMATIC_EMPTY_ELEMENTS)) {
            return _automaticEmptyElements;
        } else if (name.equals(NO_EMPTY_ELEMENT_TAG)) {
            return _noEmptyElementTag;
        } else if (name.equals(INDENTATION)) {
            return _indentation;
        } else if (name.equals(LINE_SEPARATOR)) {
            return _lineSeparator;
        } else {
            throw new IllegalArgumentException("Property: " + name
                    + " not supported");
        }
    }

References javolution.xml.internal.stream.XMLOutputFactoryImpl._automaticEmptyElements, javolution.xml.internal.stream.XMLOutputFactoryImpl._indentation, javolution.xml.internal.stream.XMLOutputFactoryImpl._isRepairingNamespaces, javolution.xml.internal.stream.XMLOutputFactoryImpl._lineSeparator, javolution.xml.internal.stream.XMLOutputFactoryImpl._noEmptyElementTag, javolution.xml.internal.stream.XMLOutputFactoryImpl._repairingPrefix, javolution.xml.stream.XMLOutputFactory.AUTOMATIC_EMPTY_ELEMENTS, javolution.xml.stream.XMLOutputFactory.INDENTATION, javolution.xml.stream.XMLOutputFactory.IS_REPAIRING_NAMESPACES, javolution.xml.stream.XMLOutputFactory.LINE_SEPARATOR, javolution.xml.stream.XMLOutputFactory.NO_EMPTY_ELEMENT_TAG, and javolution.xml.stream.XMLOutputFactory.REPAIRING_PREFIX.

isPropertySupported()

boolean javolution.xml.internal.stream.XMLOutputFactoryImpl.isPropertySupported

(

String

name

)

Queries the set of properties that this factory supports.

Parameters

name	the name of the property (may not be null).

Returns

true if the property is supported; false otherwise.

Implements javolution.xml.stream.XMLOutputFactory.

Definition at line 92 of file XMLOutputFactoryImpl.java.

                                                    {
        return name.equals(IS_REPAIRING_NAMESPACES)
                || name.equals(REPAIRING_PREFIX)
                || name.equals(AUTOMATIC_EMPTY_ELEMENTS)
                || name.equals(NO_EMPTY_ELEMENT_TAG)
                || name.equals(INDENTATION) || name.equals(LINE_SEPARATOR);
    }

References javolution.xml.stream.XMLOutputFactory.AUTOMATIC_EMPTY_ELEMENTS, javolution.xml.stream.XMLOutputFactory.INDENTATION, javolution.xml.stream.XMLOutputFactory.IS_REPAIRING_NAMESPACES, javolution.xml.stream.XMLOutputFactory.LINE_SEPARATOR, javolution.xml.stream.XMLOutputFactory.NO_EMPTY_ELEMENT_TAG, and javolution.xml.stream.XMLOutputFactory.REPAIRING_PREFIX.

newWriter()

XMLStreamWriterImpl javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter ( )

private

Definition at line 128 of file XMLOutputFactoryImpl.java.

                                            {
        XMLStreamWriterImpl xmlWriter = _recycled.pollLast();
        if (xmlWriter == null) xmlWriter = new XMLStreamWriterImpl(this);
        xmlWriter.setRepairingNamespaces(_isRepairingNamespaces.booleanValue());
        xmlWriter.setRepairingPrefix(_repairingPrefix);
        xmlWriter.setIndentation(_indentation);
        xmlWriter.setLineSeparator(_lineSeparator);
        xmlWriter.setAutomaticEmptyElements(_automaticEmptyElements
                .booleanValue());
        xmlWriter.setNoEmptyElementTag(_noEmptyElementTag.booleanValue());
        return xmlWriter;
    }

References javolution.xml.internal.stream.XMLOutputFactoryImpl._automaticEmptyElements, javolution.xml.internal.stream.XMLOutputFactoryImpl._indentation, javolution.xml.internal.stream.XMLOutputFactoryImpl._isRepairingNamespaces, javolution.xml.internal.stream.XMLOutputFactoryImpl._lineSeparator, javolution.xml.internal.stream.XMLOutputFactoryImpl._noEmptyElementTag, javolution.xml.internal.stream.XMLOutputFactoryImpl._recycled, javolution.xml.internal.stream.XMLOutputFactoryImpl._repairingPrefix, javolution.xml.internal.stream.XMLStreamWriterImpl.setAutomaticEmptyElements(), javolution.xml.internal.stream.XMLStreamWriterImpl.setIndentation(), javolution.xml.internal.stream.XMLStreamWriterImpl.setLineSeparator(), javolution.xml.internal.stream.XMLStreamWriterImpl.setNoEmptyElementTag(), javolution.xml.internal.stream.XMLStreamWriterImpl.setRepairingNamespaces(), and javolution.xml.internal.stream.XMLStreamWriterImpl.setRepairingPrefix().

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.createXMLStreamWriter().

Here is the call graph for this function:

Here is the caller graph for this function:

recycle()

void javolution.xml.internal.stream.XMLOutputFactoryImpl.recycle ( XMLStreamWriterImpl  xmlWriter )

package

Recycles the specified writer instance.

Definition at line 124 of file XMLOutputFactoryImpl.java.

                                                {
        _recycled.addLast(xmlWriter);
    }

References javolution.xml.internal.stream.XMLOutputFactoryImpl._recycled.

Referenced by javolution.xml.internal.stream.XMLStreamWriterImpl.reset().

Here is the caller graph for this function:

setProperty()

void javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty	(	String	name,
		Object	value
	)		throws IllegalArgumentException

Allows the user to set specific features/properties on the underlying implementation.

Parameters

name	the name of the property.
value	the value of the property.

Exceptions

IllegalArgumentException

if the property is not supported.

Implements javolution.xml.stream.XMLOutputFactory.

Definition at line 101 of file XMLOutputFactoryImpl.java.

                                            {
        if (name.equals(IS_REPAIRING_NAMESPACES)) {
            _isRepairingNamespaces = (Boolean) value;
        } else if (name.equals(REPAIRING_PREFIX)) {
            _repairingPrefix = (String) value;
        } else if (name.equals(AUTOMATIC_EMPTY_ELEMENTS)) {
            _automaticEmptyElements = (Boolean) value;
        } else if (name.equals(NO_EMPTY_ELEMENT_TAG)) {
            _noEmptyElementTag = (Boolean) value;
        } else if (name.equals(INDENTATION)) {
            _indentation = (String) value;
        } else if (name.equals(LINE_SEPARATOR)) {
            _lineSeparator = (String) value;
        } else {
            throw new IllegalArgumentException("Property: " + name
                    + " not supported");
        }
    }

References javolution.xml.internal.stream.XMLOutputFactoryImpl._automaticEmptyElements, javolution.xml.internal.stream.XMLOutputFactoryImpl._indentation, javolution.xml.internal.stream.XMLOutputFactoryImpl._isRepairingNamespaces, javolution.xml.internal.stream.XMLOutputFactoryImpl._lineSeparator, javolution.xml.internal.stream.XMLOutputFactoryImpl._noEmptyElementTag, javolution.xml.internal.stream.XMLOutputFactoryImpl._repairingPrefix, javolution.xml.stream.XMLOutputFactory.AUTOMATIC_EMPTY_ELEMENTS, javolution.xml.stream.XMLOutputFactory.INDENTATION, javolution.xml.stream.XMLOutputFactory.IS_REPAIRING_NAMESPACES, javolution.xml.stream.XMLOutputFactory.LINE_SEPARATOR, javolution.xml.stream.XMLOutputFactory.NO_EMPTY_ELEMENT_TAG, and javolution.xml.stream.XMLOutputFactory.REPAIRING_PREFIX.

Member Data Documentation

_automaticEmptyElements

Boolean javolution.xml.internal.stream.XMLOutputFactoryImpl._automaticEmptyElements = Boolean.FALSE

private

Definition at line 24 of file XMLOutputFactoryImpl.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

_indentation

String javolution.xml.internal.stream.XMLOutputFactoryImpl._indentation

private

Definition at line 27 of file XMLOutputFactoryImpl.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

_isRepairingNamespaces

Boolean javolution.xml.internal.stream.XMLOutputFactoryImpl._isRepairingNamespaces = Boolean.FALSE

private

Definition at line 30 of file XMLOutputFactoryImpl.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

_lineSeparator

String javolution.xml.internal.stream.XMLOutputFactoryImpl._lineSeparator = "\n"

private

Definition at line 33 of file XMLOutputFactoryImpl.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

_noEmptyElementTag

Boolean javolution.xml.internal.stream.XMLOutputFactoryImpl._noEmptyElementTag = Boolean.FALSE

private

Definition at line 36 of file XMLOutputFactoryImpl.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

_recycled

FastTable<XMLStreamWriterImpl> javolution.xml.internal.stream.XMLOutputFactoryImpl._recycled

private

Initial value:

= new FastTable<XMLStreamWriterImpl>()
            .shared()

Definition at line 41 of file XMLOutputFactoryImpl.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.recycle().

_repairingPrefix

String javolution.xml.internal.stream.XMLOutputFactoryImpl._repairingPrefix = "ns"

private

Definition at line 39 of file XMLOutputFactoryImpl.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.newWriter(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

AUTOMATIC_EMPTY_ELEMENTS

final String javolution.xml.stream.XMLOutputFactory.AUTOMATIC_EMPTY_ELEMENTS = "javolution.xml.stream.automaticEmptyElements"

staticinherited

Property indicating if the stream writers are allowed to automatically output empty elements when a start element is immediately followed by matching end element (type: Boolean, default: FALSE).

Definition at line 92 of file XMLOutputFactory.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLStreamWriterImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.isPropertySupported(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

INDENTATION

final String javolution.xml.stream.XMLOutputFactory.INDENTATION = "javolution.xml.stream.indentation"

staticinherited

Property used to specify an indentation string; non-null indentation forces the writer to write elements into separate lines (type: String, default: null).

Definition at line 78 of file XMLOutputFactory.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLStreamWriterImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.isPropertySupported(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

IS_REPAIRING_NAMESPACES

final String javolution.xml.stream.XMLOutputFactory.IS_REPAIRING_NAMESPACES = "javolution.xml.stream.isRepairingNamespaces"

staticinherited

Property used to set prefix defaulting on the output side (type: Boolean, default: FALSE).

Definition at line 63 of file XMLOutputFactory.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLStreamWriterImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.isPropertySupported(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

LINE_SEPARATOR

final String javolution.xml.stream.XMLOutputFactory.LINE_SEPARATOR = "javolution.xml.stream.lineSeparator"

staticinherited

Property used to specify the new line characters (type: String, default: "\n").

Definition at line 84 of file XMLOutputFactory.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLStreamWriterImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.isPropertySupported(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

NO_EMPTY_ELEMENT_TAG

final String javolution.xml.stream.XMLOutputFactory.NO_EMPTY_ELEMENT_TAG = "javolution.xml.stream.noEmptyElementTag"

staticinherited

Property indicating if the stream writers are not allowed to use empty element tags (type: Boolean, default: FALSE). When set, this property forces the use of start/end element tag (e.g. i.e. "&lt;empty /&gt;" replaced by "&lt;empty&gt;&lt;/empty&gt;"), This property takes precedence over AUTOMATIC_EMPTY_ELEMENTS.

Definition at line 102 of file XMLOutputFactory.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLStreamWriterImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.isPropertySupported(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

REPAIRING_PREFIX

final String javolution.xml.stream.XMLOutputFactory.REPAIRING_PREFIX = "javolution.xml.stream.repairingPrefix"

staticinherited

Property used to specify the prefix to be appended by a trailing part (a sequence number) in order to make it unique to be usable as a temporary non-colliding prefix when repairing namespaces (type: String, default: "ns").

Definition at line 71 of file XMLOutputFactory.java.

Referenced by javolution.xml.internal.stream.XMLOutputFactoryImpl.getProperty(), javolution.xml.internal.stream.XMLStreamWriterImpl.getProperty(), javolution.xml.internal.stream.XMLOutputFactoryImpl.isPropertySupported(), and javolution.xml.internal.stream.XMLOutputFactoryImpl.setProperty().

---

The documentation for this class was generated from the following file:

• XMLOutputFactoryImpl.java