org.apache.camel.model.dataformat

Class YAMLDataFormat

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.DataFormatDefinition

org.apache.camel.model.dataformat.YAMLDataFormat

All Implemented Interfaces:

OtherAttributesAware

@Metadata(firstVersion="2.17.0",
          label="dataformat,transformation,yaml",
          title="YAML")
public class YAMLDataFormat
extends DataFormatDefinition

YAML is a data format to marshal and unmarshal Java objects to and from YAML.

Version:

Constructor Summary

Constructors

Constructor and Description
YAMLDataFormat()
YAMLDataFormat(YAMLLibrary library)
YAMLDataFormat(YAMLLibrary library, Class<?> unmarshalType)

Method Summary

Modifier and Type	Method and Description
protected void	configureDataFormat(DataFormat dataFormat, CamelContext camelContext) Allows derived classes to customize the data format
protected void	configureSnakeDataFormat(DataFormat dataFormat, CamelContext camelContext)
protected DataFormat	createDataFormat(RouteContext routeContext) Factory method to create the data format instance
ClassLoader	getClassLoader()
String	getConstructor()
String	getDumperOptions()
YAMLLibrary	getLibrary()
String	getRepresenter()
String	getResolver()
List<YAMLTypeFilterDefinition>	getTypeFilters()
Class<?>	getUnmarshalType()
String	getUnmarshalTypeName()
boolean	isAllowAnyType()
boolean	isPrettyFlow()
boolean	isUseApplicationContextClassLoader()
void	setAllowAnyType(boolean allowAnyType) Allow any class to be un-marshaled
void	setClassLoader(ClassLoader classLoader) Set a custom classloader
void	setConstructor(String constructor) BaseConstructor to construct incoming documents.
void	setDumperOptions(String dumperOptions) DumperOptions to configure outgoing objects.
void	setLibrary(YAMLLibrary library) Which yaml library to use.
void	setPrettyFlow(boolean prettyFlow) Force the emitter to produce a pretty YAML document when using the flow style.
protected void	setProperty(DataFormat dataFormat, CamelContext camelContext, String propertyName, Object propertyValue)
protected void	setPropertyRef(DataFormat dataFormat, CamelContext camelContext, String propertyName, String propertyValue)
void	setRepresenter(String representer) Representer to emit outgoing objects.
void	setResolver(String resolver) Resolver to detect implicit type
void	setTypeFilters(List<YAMLTypeFilterDefinition> typeFilters) Set the types SnakeYAML is allowed to un-marshall
void	setUnmarshalType(Class<?> type) Class of the object to be created
void	setUnmarshalTypeName(String unmarshalTypeName) Class name of the java type to use when unarmshalling
void	setUseApplicationContextClassLoader(boolean useApplicationContextClassLoader) Use ApplicationContextClassLoader as custom ClassLoader

Methods inherited from class org.apache.camel.model.DataFormatDefinition

configureDataFormat, getContentTypeHeader, getDataFormat, getDataFormat, getDataFormat, getDataFormatName, getOtherAttributes, getShortName, setContentTypeHeader, setDataFormat, setDataFormatName, setOtherAttributes, setProperty, setProperty

Methods inherited from class org.apache.camel.model.IdentifiedType

getId, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

YAMLDataFormat

public YAMLDataFormat()

YAMLDataFormat

public YAMLDataFormat(YAMLLibrary library)

YAMLDataFormat

public YAMLDataFormat(YAMLLibrary library,
                      Class<?> unmarshalType)

Method Detail

getLibrary

public YAMLLibrary getLibrary()

setLibrary

public void setLibrary(YAMLLibrary library)

Which yaml library to use.

By default it is SnakeYAML

getUnmarshalType

public Class<?> getUnmarshalType()

setUnmarshalType

public void setUnmarshalType(Class<?> type)

Class of the object to be created

getUnmarshalTypeName

public String getUnmarshalTypeName()

setUnmarshalTypeName

public void setUnmarshalTypeName(String unmarshalTypeName)

Class name of the java type to use when unarmshalling

getClassLoader

public ClassLoader getClassLoader()

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Set a custom classloader

getConstructor

public String getConstructor()

setConstructor

public void setConstructor(String constructor)

BaseConstructor to construct incoming documents.

getRepresenter

public String getRepresenter()

setRepresenter

public void setRepresenter(String representer)

Representer to emit outgoing objects.

getDumperOptions

public String getDumperOptions()

setDumperOptions

public void setDumperOptions(String dumperOptions)

DumperOptions to configure outgoing objects.

getResolver

public String getResolver()

setResolver

public void setResolver(String resolver)

Resolver to detect implicit type

isUseApplicationContextClassLoader

public boolean isUseApplicationContextClassLoader()

setUseApplicationContextClassLoader

public void setUseApplicationContextClassLoader(boolean useApplicationContextClassLoader)

Use ApplicationContextClassLoader as custom ClassLoader

isPrettyFlow

public boolean isPrettyFlow()

setPrettyFlow

public void setPrettyFlow(boolean prettyFlow)

Force the emitter to produce a pretty YAML document when using the flow style.

isAllowAnyType

public boolean isAllowAnyType()

setAllowAnyType

public void setAllowAnyType(boolean allowAnyType)

Allow any class to be un-marshaled

getTypeFilters

public List<YAMLTypeFilterDefinition> getTypeFilters()

setTypeFilters

public void setTypeFilters(List<YAMLTypeFilterDefinition> typeFilters)

Set the types SnakeYAML is allowed to un-marshall

createDataFormat

protected DataFormat createDataFormat(RouteContext routeContext)

Description copied from class: DataFormatDefinition

Factory method to create the data format instance

Overrides:

createDataFormat in class DataFormatDefinition

configureDataFormat

protected void configureDataFormat(DataFormat dataFormat,
                                   CamelContext camelContext)

Description copied from class: DataFormatDefinition

Allows derived classes to customize the data format

Overrides:

configureDataFormat in class DataFormatDefinition

configureSnakeDataFormat

protected void configureSnakeDataFormat(DataFormat dataFormat,
                                        CamelContext camelContext)

setProperty

protected void setProperty(DataFormat dataFormat,
                           CamelContext camelContext,
                           String propertyName,
                           Object propertyValue)

setPropertyRef

protected void setPropertyRef(DataFormat dataFormat,
                              CamelContext camelContext,
                              String propertyName,
                              String propertyValue)