org.apache.camel.model

Class DataFormatDefinition

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.DataFormatDefinition

All Implemented Interfaces:

OtherAttributesAware

Direct Known Subclasses:

AvroDataFormat, BarcodeDataFormat, Base64DataFormat, BeanioDataFormat, BindyDataFormat, BoonDataFormat, CastorDataFormat, CryptoDataFormat, CsvDataFormat, CustomDataFormat, FlatpackDataFormat, GzipDataFormat, HL7DataFormat, IcalDataFormat, JacksonXMLDataFormat, JaxbDataFormat, JibxDataFormat, JsonDataFormat, PGPDataFormat, ProtobufDataFormat, RssDataFormat, SerializationDataFormat, SoapJaxbDataFormat, StringDataFormat, SyslogDataFormat, TarFileDataFormat, TidyMarkupDataFormat, UniVocityAbstractDataFormat, XMLBeansDataFormat, XmlJsonDataFormat, XmlRpcDataFormat, XMLSecurityDataFormat, XStreamDataFormat, ZipDataFormat, ZipFileDataFormat

@Metadata(label="dataformat,transformation")
public class DataFormatDefinition
extends IdentifiedType
implements OtherAttributesAware

Represents a Camel data format

Constructor Summary

Constructors

Modifier	Constructor and Description
	DataFormatDefinition()
	DataFormatDefinition(DataFormat dataFormat)
protected	DataFormatDefinition(String dataFormatName)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureDataFormat(DataFormat dataFormat) Deprecated. use configureDataFormat(org.apache.camel.spi.DataFormat, org.apache.camel.CamelContext)
protected void	configureDataFormat(DataFormat dataFormat, CamelContext camelContext) Allows derived classes to customize the data format
protected DataFormat	createDataFormat(RouteContext routeContext) Factory method to create the data format instance
DataFormat	getDataFormat()
DataFormat	getDataFormat(RouteContext routeContext)
static DataFormat	getDataFormat(RouteContext routeContext, DataFormatDefinition type, String ref) Factory method to create the data format
String	getDataFormatName()
Map<QName,Object>	getOtherAttributes() Adds optional attribute to use as property placeholder
String	getShortName()
void	setDataFormat(DataFormat dataFormat)
void	setDataFormatName(String dataFormatName)
void	setOtherAttributes(Map<QName,Object> otherAttributes) Adds an optional attribute
protected void	setProperty(CamelContext camelContext, Object bean, String name, Object value) Sets a named property on the data format instance using introspection
protected void	setProperty(Object bean, String name, Object value) Deprecated. use setProperty(org.apache.camel.CamelContext, Object, String, Object)

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

DataFormatDefinition

public DataFormatDefinition()

DataFormatDefinition

public DataFormatDefinition(DataFormat dataFormat)

DataFormatDefinition

protected DataFormatDefinition(String dataFormatName)

Method Detail

getDataFormat

public static DataFormat getDataFormat(RouteContext routeContext,
                       DataFormatDefinition type,
                       String ref)

Factory method to create the data format

Parameters:

routeContext - route context

type - the data format type

ref - reference to lookup for a data format

Returns:

the data format or null if not possible to create

getDataFormat

public DataFormat getDataFormat(RouteContext routeContext)

createDataFormat

protected DataFormat createDataFormat(RouteContext routeContext)

Factory method to create the data format instance

configureDataFormat

@Deprecated
protected void configureDataFormat(DataFormat dataFormat)

Deprecated. use configureDataFormat(org.apache.camel.spi.DataFormat, org.apache.camel.CamelContext)

Allows derived classes to customize the data format

configureDataFormat

protected void configureDataFormat(DataFormat dataFormat,
                       CamelContext camelContext)

Allows derived classes to customize the data format

setProperty

@Deprecated
protected void setProperty(Object bean,
                          String name,
                          Object value)

Deprecated. use setProperty(org.apache.camel.CamelContext, Object, String, Object)

Sets a named property on the data format instance using introspection

setProperty

protected void setProperty(CamelContext camelContext,
               Object bean,
               String name,
               Object value)

Sets a named property on the data format instance using introspection

getDataFormatName

public String getDataFormatName()

setDataFormatName

public void setDataFormatName(String dataFormatName)

getDataFormat

public DataFormat getDataFormat()

setDataFormat

public void setDataFormat(DataFormat dataFormat)

getOtherAttributes

public Map<QName,Object> getOtherAttributes()

Description copied from interface: OtherAttributesAware

Adds optional attribute to use as property placeholder

Specified by:

getOtherAttributes in interface OtherAttributesAware

setOtherAttributes

public void setOtherAttributes(Map<QName,Object> otherAttributes)

Adds an optional attribute

Specified by:

setOtherAttributes in interface OtherAttributesAware

getShortName

public String getShortName()