Package org.camunda.spin
Class DataFormats
java.lang.Object
org.camunda.spin.DataFormats
Provides access to all builtin data formats.
- Author:
 - Sebastian Menski, Daniel Meyer
 
- 
Field Summary
Fields - 
Constructor Summary
Constructors - 
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyConfigurator(Map<String, DataFormat<?>> dataFormats, DataFormatConfigurator configurator) protected voidapplyConfigurators(Map<String, DataFormat<?>> dataFormats, ClassLoader classloader) protected voidapplyConfigurators(Map<String, DataFormat<?>> dataFormats, ClassLoader classloader, List<DataFormatConfigurator> dataFormatConfigurators) protected voidDetect all available dataformats on the classpath using aServiceLoader.Set<DataFormat<? extends Spin<?>>>static Set<DataFormat<? extends Spin<?>>>static DataFormat<? extends Spin<?>>getDataFormat(String dataFormatName) Returns the registered data format for the given name.DataFormat<? extends Spin<?>>getDataFormatByName(String name) static DataFormatsProvides 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 voidstatic voidloadDataFormats(ClassLoader classloader) static voidloadDataFormats(ClassLoader classloader, List<DataFormatConfigurator> configurators) static voidloadDataFormats(ClassLoader classloader, Map configurationProperties) protected voidregisterCustomDataFormats(Map<String, DataFormat<?>> dataFormats, ClassLoader classloader) protected voidregisterCustomDataFormats(Map<String, DataFormat<?>> dataFormats, ClassLoader classloader, Map<String, Object> configurationProperties) voidregisterDataFormats(ClassLoader classloader) voidregisterDataFormats(ClassLoader classloader, List<DataFormatConfigurator> configurators) voidregisterDataFormats(ClassLoader classloader, List<DataFormatConfigurator> configurators, Map<String, Object> configurationProperties) protected voidregisterProvider(Map<String, DataFormat<?>> dataFormats, DataFormatProvider provider) protected voidregisterProvider(Map<String, DataFormat<?>> dataFormats, DataFormatProvider provider, Map<String, Object> configurationProperties) static DataFormat<SpinXmlElement>xml()Returns the global xml data format that can be provided with configuration that applies to any Spin xml operation. 
- 
Field Details
- 
JSON_DATAFORMAT_NAME
 - 
XML_DATAFORMAT_NAME
 - 
availableDataFormats
 
 - 
 - 
Constructor Details
- 
DataFormats
public DataFormats() 
 - 
 - 
Method Details
- 
getInstance
Provides the global instance of the DataFormats manager.- Returns:
 - the global instance.
 
 - 
xml
Returns the global xml data format that can be provided with configuration that applies to any Spin xml operation. - 
json
Returns the global json data format that can be provided with configuration that applies to any Spin json operation. - 
getDataFormat
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
- Returns:
 - a set of all registered data formats
 
 - 
getAllAvailableDataFormats
 - 
getDataFormatByName
 - 
ensureDataformatsInitialized
protected void ensureDataformatsInitialized()Detect all available dataformats on the classpath using aServiceLoader. - 
registerDataFormats
 - 
registerDataFormats
public void registerDataFormats(ClassLoader classloader, List<DataFormatConfigurator> configurators)  - 
registerDataFormats
public void registerDataFormats(ClassLoader classloader, List<DataFormatConfigurator> configurators, Map<String, Object> configurationProperties)  - 
registerCustomDataFormats
protected void registerCustomDataFormats(Map<String, DataFormat<?>> dataFormats, ClassLoader classloader)  - 
registerCustomDataFormats
protected void registerCustomDataFormats(Map<String, DataFormat<?>> dataFormats, ClassLoader classloader, Map<String, Object> configurationProperties)  - 
registerProvider
 - 
registerProvider
protected void registerProvider(Map<String, DataFormat<?>> dataFormats, DataFormatProvider provider, Map<String, Object> configurationProperties)  - 
applyConfigurators
 - 
applyConfigurators
protected void applyConfigurators(Map<String, DataFormat<?>> dataFormats, ClassLoader classloader, List<DataFormatConfigurator> dataFormatConfigurators)  - 
applyConfigurator
protected void applyConfigurator(Map<String, DataFormat<?>> dataFormats, DataFormatConfigurator configurator)  - 
loadDataFormats
public static void loadDataFormats() - 
loadDataFormats
 - 
loadDataFormats
public static void loadDataFormats(ClassLoader classloader, List<DataFormatConfigurator> configurators)  - 
loadDataFormats
 
 -