Package com.sun.xml.ws.api.streaming

Class XMLStreamWriterFactory

java.lang.Object

com.sun.xml.ws.api.streaming.XMLStreamWriterFactory

Direct Known Subclasses:

XMLStreamWriterFactory.Default, XMLStreamWriterFactory.NoLock, XMLStreamWriterFactory.Zephyr

public abstract class XMLStreamWriterFactory
extends Object

Factory for XMLStreamWriter.

This wraps XMLOutputFactory and allows us to reuse XMLStreamWriter instances when appropriate.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XMLStreamWriterFactory.Default	Default XMLStreamWriterFactory implementation that can work with any XMLOutputFactory.
static class	XMLStreamWriterFactory.HasEncodingWriter
static class	XMLStreamWriterFactory.NoLock	For XMLOutputFactory is thread safe.
static interface	XMLStreamWriterFactory.RecycleAware	Interface that can be implemented by XMLStreamWriter to be notified when it's recycled.
static class	XMLStreamWriterFactory.Zephyr	XMLStreamWriterFactory implementation for Sun's StaX implementation.

Constructor Summary

Constructors

Constructor	Description
XMLStreamWriterFactory()

Method Summary

Modifier and Type	Method	Description
static XMLStreamWriter	create(OutputStream out)	Short-cut for create(OutputStream, String) with UTF-8.
static XMLStreamWriter	create(OutputStream out, String encoding)
static XMLStreamWriter	createXMLStreamWriter(OutputStream out)	Deprecated. Use create(OutputStream)
static XMLStreamWriter	createXMLStreamWriter(OutputStream out, String encoding)	Deprecated. Use create(OutputStream, String)
static XMLStreamWriter	createXMLStreamWriter(OutputStream out, String encoding, boolean declare)	Deprecated. Use create(OutputStream, String).
abstract XMLStreamWriter	doCreate(OutputStream out)	See create(OutputStream) for the contract.
abstract XMLStreamWriter	doCreate(OutputStream out, String encoding)	See create(OutputStream,String) for the contract.
abstract void	doRecycle(XMLStreamWriter r)	See recycle(XMLStreamWriter) for the contract.
static XMLStreamWriterFactory	get()	Gets the singleton instance.
static void	recycle(XMLStreamWriter r)	Should be invoked when the code finished using an XMLStreamWriter.
static void	set(XMLStreamWriterFactory f)	Overrides the singleton XMLStreamWriterFactory instance that the JAX-WS RI uses.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLStreamWriterFactory

public XMLStreamWriterFactory()

Method Detail

doCreate

public abstract XMLStreamWriter doCreate(OutputStream out)

See create(OutputStream) for the contract. This method may be invoked concurrently.

doCreate

public abstract XMLStreamWriter doCreate(OutputStream out,
                                         String encoding)

See create(OutputStream,String) for the contract. This method may be invoked concurrently.

doRecycle

public abstract void doRecycle(XMLStreamWriter r)

See recycle(XMLStreamWriter) for the contract. This method may be invoked concurrently.

recycle

public static void recycle(XMLStreamWriter r)

Should be invoked when the code finished using an XMLStreamWriter.

If the recycled instance implements XMLStreamWriterFactory.RecycleAware, XMLStreamWriterFactory.RecycleAware.onRecycled() will be invoked to let the instance know that it's being recycled.

It is not a hard requirement to call this method on every XMLStreamReader instance. Not doing so just reduces the performance by throwing away possibly reusable instances. So the caller should always consider the effort it takes to recycle vs the possible performance gain by doing so.

This method may be invked by multiple threads concurrently.

Parameters:

r - The XMLStreamReader instance that the caller finished using. This could be any XMLStreamReader implementation, not just the ones that were created from this factory. So the implementation of this class needs to be aware of that.

get

@NotNull
public static XMLStreamWriterFactory get()

Gets the singleton instance.

set

public static void set(@NotNull
                       XMLStreamWriterFactory f)

Overrides the singleton XMLStreamWriterFactory instance that the JAX-WS RI uses.

Parameters:

f - must not be null.

create

public static XMLStreamWriter create(OutputStream out)

Short-cut for create(OutputStream, String) with UTF-8.

create

public static XMLStreamWriter create(OutputStream out,
                                     String encoding)

createXMLStreamWriter

public static XMLStreamWriter createXMLStreamWriter(OutputStream out)

Deprecated.

Use create(OutputStream)

createXMLStreamWriter

public static XMLStreamWriter createXMLStreamWriter(OutputStream out,
                                                    String encoding)

Deprecated.

Use create(OutputStream, String)

createXMLStreamWriter

public static XMLStreamWriter createXMLStreamWriter(OutputStream out,
                                                    String encoding,
                                                    boolean declare)

Deprecated.

Use create(OutputStream, String). The boolean flag was unused anyway.