com.att.ajsc.csilogging.util

Class JAXBmar

java.lang.Object

com.att.ajsc.csilogging.util.JAXBmar

All Implemented Interfaces:

PoolableObjectCreator

public class JAXBmar
extends Object
implements PoolableObjectCreator

The JAXBmar class provides a thread-safe implementation for using non-thread safe JAXB Marshaller's.

Constructor Summary

Constructors

Constructor and Description
JAXBmar(boolean isFragment, Class<?>... classes) Constructs a JAXBmar object bound to the supplied classes and specified fragment handling.
JAXBmar(Class<?>... classes) Constructs a JAXBmar object bound to the supplied classes.
JAXBmar(QName qname, boolean isFragment, Class<?>... classes) Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes, QName, and fragment handling.
JAXBmar(QName qname, Class<?>... classes) Constructs a JAXBmar object bound to the supplied classes and QName.
JAXBmar(QName qname, String encoding, Class<?>... classes) Constructs a JAXBmar object bound to the supplied classes, QName, and encoding.
JAXBmar(RuntimeTIG tig, Class<?>... classes) Deprecated.
JAXBmar(RuntimeTIG tig, QName qname) Constructs a JAXBmar object bound to the class name associated with the supplied QName in the supplied RuntimeTIG.
JAXBmar(String encoding, Class<?>... classes) Constructs a JAXBmar object bound to the supplied classes and specified encoding.

Method Summary

Modifier and Type	Method and Description
Marshaller	createPoolableObject() Creates and returns a new instance of the Object type being pooled.
Marshaller	get() Deprecated.
static String	getKey(String encoding, boolean fragment, QName qname, Class<?>... classes) Generates a key name based on the supplied inputs for storing this object in the static HashMap for reuse.
Class<?>	getMarshalClass() Returns the class bound to the JAXBmar.
Map<String,String>	getMetadata() Returns a key/value map of meta-data about the Object type being pooled.
static JAXBmar	instance(boolean isFragment, Class<?>... classes) Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes and specified fragment handling.
static JAXBmar	instance(Class<?>... classes) Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes.
static JAXBmar	instance(QName qname, boolean isFragment, Class<?>... classes) Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes, QName, and fragment handling.
static JAXBmar	instance(QName qname, Class<?>... classes) Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes and QName.
static JAXBmar	instance(QName qname, String encoding, Class<?>... classes) Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes, QName, and encoding.
static JAXBmar	instance(RuntimeTIG tig, Class<?>... classes) Deprecated.
static JAXBmar	instance(RuntimeTIG tig, QName qname) Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the class name associated with the supplied QName in the supplied RuntimeTIG.
static JAXBmar	instance(String encoding, Class<?>... classes) Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes and specified encoding.
<O> O	marshal(O o, Document doc)
<O> O	marshal(O o, Document doc, Class<O> theClass)
<O> O	marshal(O o, OutputStream os)
<O> O	marshal(O o, OutputStream os, Class<O> theClass)
<O> O	marshal(O o, Writer writer)
<O> O	marshal(O o, Writer writer, Class<O> theClass)
<O> String	stringify(O o)

Methods inherited from class java.lang.Object

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

Constructor Detail

JAXBmar

public JAXBmar(Class<?>... classes)

Constructs a JAXBmar object bound to the supplied classes.

Parameters:

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

JAXBmar

public JAXBmar(boolean isFragment,
               Class<?>... classes)

Constructs a JAXBmar object bound to the supplied classes and specified fragment handling.

Parameters:

isFragment - A boolean flag indicating whether or not to include the XML fragment in the marshalled XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

JAXBmar

public JAXBmar(String encoding,
               Class<?>... classes)

Constructs a JAXBmar object bound to the supplied classes and specified encoding.

Parameters:

encoding - The output encoding in the marshalled XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

JAXBmar

public JAXBmar(QName qname,
               Class<?>... classes)

Constructs a JAXBmar object bound to the supplied classes and QName.

Parameters:

qname - The QName used to marshal the XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

JAXBmar

public JAXBmar(QName qname,
               String encoding,
               Class<?>... classes)

Constructs a JAXBmar object bound to the supplied classes, QName, and encoding.

Parameters:

qname - The QName used to marshal the XML data.

encoding - The output encoding in the marshalled XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

JAXBmar

public JAXBmar(QName qname,
               boolean isFragment,
               Class<?>... classes)

Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes, QName, and fragment handling.

Parameters:

qname - The QName used to marshal the XML data.

isFragment - A boolean flag indicating whether or not to include the XML fragment in the marshalled XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

JAXBmar

@Deprecated
public JAXBmar(RuntimeTIG tig,
                           Class<?>... classes)

Deprecated.

Constructs a JAXBmar object bound to the QName associated with the supplied classes in the supplied RuntimeTIG.

Parameters:

tig - The RuntimeTIG used to lookup the class name from the supplied QName.

classes - The classes used to lookup the QName in the supplied RuntimeTIG. Note: This method is not guaranteed to be safe and is therefore not recommended for future use.

JAXBmar

public JAXBmar(RuntimeTIG tig,
               QName qname)

Constructs a JAXBmar object bound to the class name associated with the supplied QName in the supplied RuntimeTIG.

Parameters:

tig - The RuntimeTIG used to lookup the class name from the supplied QName.

qname - The QName used to lookup the class name in the supplied RuntimeTIG.

Method Detail

get

@Deprecated
public Marshaller get()

Deprecated.

Be careful....always returns null. The use of this method should be removed as pool initialization is done automatically. Not sure if M2E-CSI is using this anymore so it hasn't been removed.

Returns:

Marshaller

getKey

public static String getKey(String encoding,
                            boolean fragment,
                            QName qname,
                            Class<?>... classes)

Generates a key name based on the supplied inputs for storing this object in the static HashMap for reuse.

Parameters:

encoding - The output encoding in the marshalled XML data.

fragment - Boolean flag indicating whether or not to include the XML fragment in the marshalled XML data.

qname - The QName used to marshal the XML data.

classes - An array of classes bound to the JAXBContext.

Returns:

A formatted string corresponding to the meta-data of this object.

instance

public static JAXBmar instance(Class<?>... classes)

Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes.

Parameters:

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

Returns:

A JAXBmar instance bound to the supplied classes.

instance

public static JAXBmar instance(boolean isFragment,
                               Class<?>... classes)

Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes and specified fragment handling.

Parameters:

isFragment - A boolean flag indicating whether or not to include the XML fragment in the marshalled XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

Returns:

A JAXBmar instance bound to the supplied classes and specified fragment handling.

instance

public static JAXBmar instance(String encoding,
                               Class<?>... classes)

Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes and specified encoding.

Parameters:

encoding - The output encoding in the marshalled XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

Returns:

A JAXBmar instance bound to the supplied classes and specified encoding.

instance

public static JAXBmar instance(QName qname,
                               Class<?>... classes)

Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes and QName.

Parameters:

qname - The QName used to marshal the XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

Returns:

A JAXBmar instance bound to the supplied classes and QName.

instance

public static JAXBmar instance(QName qname,
                               String encoding,
                               Class<?>... classes)

Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes, QName, and encoding.

Parameters:

qname - The QName used to marshal the XML data.

encoding - The output encoding in the marshalled XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

Returns:

A JAXBmar instance bound to the supplied classes, QName and encoding.

instance

public static JAXBmar instance(QName qname,
                               boolean isFragment,
                               Class<?>... classes)

Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the supplied classes, QName, and fragment handling.

Parameters:

qname - The QName used to marshal the XML data.

isFragment - A boolean flag indicating whether or not to include the XML fragment in the marshalled XML data.

classes - The classes bound to the JAXBContext for the desired JAXBmar instance.

Returns:

A JAXBmar instance bound to the supplied classes, QName and fragment handling.

instance

@Deprecated
public static JAXBmar instance(RuntimeTIG tig,
                                           Class<?>... classes)

Deprecated.

Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the QName associated with the supplied classes in the supplied RuntimeTIG.

Parameters:

tig - The RuntimeTIG used to lookup the class name from the supplied QName.

classes - The classes used to lookup the QName in the supplied RuntimeTIG.

Returns:

A JAXBmar instance bound to the QName associated with the classes in the RuntimeTIG. Note: This method is not guaranteed to be safe and is therefore not recommended for future use.

instance

public static JAXBmar instance(RuntimeTIG tig,
                               QName qname)

Returns a JAXBmar (existing if available in the cache, otherwise new) instance bound to the class name associated with the supplied QName in the supplied RuntimeTIG.

Parameters:

tig - The RuntimeTIG used to lookup the class name from the supplied QName.

qname - The QName used to lookup the class name in the supplied RuntimeTIG.

Returns:

A JAXBmar instance bound to the class name associated with the QName in the RuntimeTIG.

marshal

public <O> O marshal(O o,
                     Writer writer)
              throws JAXBException

Throws:

JAXBException

marshal

public <O> O marshal(O o,
                     OutputStream os)
              throws JAXBException

Throws:

JAXBException

marshal

public <O> O marshal(O o,
                     Document doc)
              throws JAXBException

Throws:

JAXBException

marshal

public <O> O marshal(O o,
                     Writer writer,
                     Class<O> theClass)
              throws JAXBException

Throws:

JAXBException

marshal

public <O> O marshal(O o,
                     OutputStream os,
                     Class<O> theClass)
              throws JAXBException

Throws:

JAXBException

marshal

public <O> O marshal(O o,
                     Document doc,
                     Class<O> theClass)
              throws JAXBException

Throws:

JAXBException

stringify

public <O> String stringify(O o)
                     throws JAXBException

Throws:

JAXBException

getMarshalClass

public Class<?> getMarshalClass()

Returns the class bound to the JAXBmar.

Returns:

The class bound to the JAXBmar.

createPoolableObject

public Marshaller createPoolableObject()

Description copied from interface: PoolableObjectCreator

Creates and returns a new instance of the Object type being pooled.

Specified by:

createPoolableObject in interface PoolableObjectCreator

Returns:

The object being pooled by the implementor.

getMetadata

public Map<String,String> getMetadata()

Description copied from interface: PoolableObjectCreator

Returns a key/value map of meta-data about the Object type being pooled.

Specified by:

getMetadata in interface PoolableObjectCreator

Returns:

A key/value map of meta-data about the pooled Object.