org.camunda.spin

Class DataFormats

java.lang.Object

org.camunda.spin.DataFormats

public class DataFormats
extends Object

Provides access to all builtin data formats.

Author:

Sebastian Menski, Daniel Meyer

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,DataFormat<?>>	availableDataFormats
static String	JSON_DATAFORMAT_NAME
static String	XML_DATAFORMAT_NAME

Constructor Summary

Constructors

Constructor and Description
DataFormats()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyConfigurator(Map<String,DataFormat<?>> dataFormats, DataFormatConfigurator configurator)
protected void	applyConfigurators(Map<String,DataFormat<?>> dataFormats, ClassLoader classloader)
protected void	ensureDataformatsInitialized() Detect all available dataformats on the classpath using a ServiceLoader.
Set<DataFormat<? extends Spin<?>>>	getAllAvailableDataFormats()
static Set<DataFormat<? extends Spin<?>>>	getAvailableDataFormats()
static DataFormat<? extends Spin<?>>	getDataFormat(String dataFormatName) Returns the registered data format for the given name.
DataFormat<? extends Spin<?>>	getDataFormatByName(String name)
static DataFormats	getInstance() Provides the global instance of the DataFormats manager.
static DataFormat<SpinJsonNode>	json() Returns the global json data format that can be provided with configuration that applies to any Spin json operation.
static void	loadDataFormats()
static void	loadDataFormats(ClassLoader classloader)
protected void	registerCustomDataFormats(Map<String,DataFormat<?>> dataFormats, ClassLoader classloader)
void	registerDataFormats(ClassLoader classloader)
protected void	registerProvider(Map<String,DataFormat<?>> dataFormats, DataFormatProvider provider)
static DataFormat<SpinXmlElement>	xml() Returns the global xml data format that can be provided with configuration that applies to any Spin xml operation.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_DATAFORMAT_NAME

public static String JSON_DATAFORMAT_NAME

XML_DATAFORMAT_NAME

public static String XML_DATAFORMAT_NAME

availableDataFormats

protected Map<String,DataFormat<?>> availableDataFormats

Constructor Detail

DataFormats

public DataFormats()

Method Detail

getInstance

public static DataFormats getInstance()

Provides the global instance of the DataFormats manager.

Returns:

the global instance.

xml

public static DataFormat<SpinXmlElement> xml()

Returns the global xml data format that can be provided with configuration that applies to any Spin xml operation.

json

public static DataFormat<SpinJsonNode> json()

Returns the global json data format that can be provided with configuration that applies to any Spin json operation.

getDataFormat

public static DataFormat<? extends Spin<?>> getDataFormat(String dataFormatName)

Returns the registered data format for the given name.

Parameters:

dataFormatName - the name of the data format

Returns:

the data format or null if non is registered for this name

getAvailableDataFormats

public static Set<DataFormat<? extends Spin<?>>> getAvailableDataFormats()

Returns:

a set of all registered data formats

getAllAvailableDataFormats

public Set<DataFormat<? extends Spin<?>>> getAllAvailableDataFormats()

getDataFormatByName

public DataFormat<? extends Spin<?>> getDataFormatByName(String name)

ensureDataformatsInitialized

protected void ensureDataformatsInitialized()

Detect all available dataformats on the classpath using a ServiceLoader.

registerDataFormats

public void registerDataFormats(ClassLoader classloader)

registerCustomDataFormats

protected void registerCustomDataFormats(Map<String,DataFormat<?>> dataFormats,
                             ClassLoader classloader)

registerProvider

protected void registerProvider(Map<String,DataFormat<?>> dataFormats,
                    DataFormatProvider provider)

applyConfigurators

protected void applyConfigurators(Map<String,DataFormat<?>> dataFormats,
                      ClassLoader classloader)

applyConfigurator

protected void applyConfigurator(Map<String,DataFormat<?>> dataFormats,
                     DataFormatConfigurator configurator)

loadDataFormats

public static void loadDataFormats()

loadDataFormats

public static void loadDataFormats(ClassLoader classloader)