DataFormatClause (Camel :: Core 2.14.4 API)

java.lang.Object
- org.apache.camel.builder.DataFormatClause<T>

public class DataFormatClause<T extends ProcessorDefinition<?>>
extends Object

An expression for constructing the different possible DataFormat options.

Version:

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataFormatClause.Operation
DataFormat operations.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataFormatClause.Operation` `DataFormat` operations.

Constructor Summary

Constructors
Constructor and Description

DataFormatClause(T processorType, DataFormatClause.Operation operation)

Constructors
Constructor and Description
`DataFormatClause(T processorType, DataFormatClause.Operation operation)`

Method Summary

Methods
Modifier and Type	Method and Description
`T`	`avro()` Uses the Avro data format
`T`	`avro(Object schema)`
`T`	`avro(String instanceClassName)`
`T`	`base64()` Uses the base64 data format
`T`	`base64(int lineLength, String lineSeparator, boolean urlSafe)` Uses the base64 data format
`T`	`beanio(String mapping, String streamName)` Uses the beanio data format
`T`	`beanio(String mapping, String streamName, String encoding)` Uses the beanio data format
`T`	`beanio(String mapping, String streamName, String encoding, boolean ignoreUnidentifiedRecords, boolean ignoreUnexpectedRecords, boolean ignoreInvalidRecords)` Uses the beanio data format
`T`	`bindy(BindyType type, Class<?> classType)` Uses the Bindy data format
`T`	`bindy(BindyType type, String... packages)` Uses the Bindy data format
`T`	`castor()` Uses the Castor data format
`T`	`castor(String mappingFile)` Uses the Castor data format
`T`	`castor(String mappingFile, boolean validation)` Uses the Castor data format
`T`	`csv()` Uses the CSV data format
`T`	`csvLazyLoad()` Uses the CSV data format for a huge file.
`T`	`custom(String ref)` Uses the custom data format
`T`	`gzip()` Uses the GZIP deflater data format
`T`	`hl7()` Uses the HL7 data format
`T`	`hl7(boolean validate)` Uses the HL7 data format
`T`	`hl7(Object parser)` Uses the HL7 data format
`T`	`jaxb()` Uses the JAXB data format
`T`	`jaxb(boolean prettyPrint)` Uses the JAXB data format turning pretty printing on or off
`T`	`jaxb(String contextPath)` Uses the JAXB data format with context path
`T`	`jibx()` Uses the JiBX data format.
`T`	`jibx(Class<?> unmarshallClass)` Uses the JiBX data format with unmarshall class.
`T`	`json()` Uses the JSON data format using the XStream json library
`T`	`json(Class<?> unmarshalType, Class<?> jsonView)` Uses the Jackson JSON data format
`T`	`json(Class<?> unmarshalType, Class<?> jsonView, String include)` Uses the Jackson JSON data format
`T`	`json(JsonLibrary library)` Uses the JSON data format
`T`	`json(JsonLibrary type, Class<?> unmarshalType)` Uses the JSON data format
`T`	`pgp(String keyFileName, String keyUserid)` Uses the PGP data format
`T`	`pgp(String keyFileName, String keyUserid, String password)` Uses the PGP data format
`T`	`pgp(String keyFileName, String keyUserid, String password, boolean armored, boolean integrity)` Uses the PGP data format
`T`	`protobuf()` Uses the protobuf data format
`T`	`protobuf(Object defaultInstance)`
`T`	`protobuf(String instanceClassName)`
`T`	`rss()` Uses the RSS data format
`T`	`secureXML()` Uses the XML Security data format
`T`	`secureXML(String secureTag, boolean secureTagContents)` Uses the XML Security data format
`T`	`secureXML(String secureTag, boolean secureTagContents, String passPhrase)` Uses the XML Security data format
`T`	`secureXML(String secureTag, boolean secureTagContents, String passPhrase, String xmlCipherAlgorithm)` Uses the XML Security data format
`T`	`secureXML(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm)` Deprecated. Use `secureXML(String, Map, boolean, String, String, String, String)` instead. Uses the XML Security data format
`T`	`secureXML(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters)` Uses the XML Security data format
`T`	`secureXML(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters, String keyPassword)` Uses the XML Security data format
`T`	`secureXML(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId)` Uses the XML Security data format
`T`	`secureXML(String secureTag, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId, String keyPassword)` Uses the XML Security data format
`T`	`secureXML(String secureTag, Map<String,String> namespaces, boolean secureTagContents)` Uses the XML Security data format
`T`	`secureXML(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String passPhrase)` Uses the XML Security data format
`T`	`secureXML(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String passPhrase, String xmlCipherAlgorithm)` Uses the XML Security data format
`T`	`secureXML(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters)` Uses the XML Security data format
`T`	`secureXML(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters, String keyPassword)` Uses the XML Security data format
`T`	`secureXML(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters, String keyPassword, String digestAlgorithm)` Uses the XML Security data format
`T`	`secureXML(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId)` Uses the XML Security data format
`T`	`secureXML(String secureTag, Map<String,String> namespaces, boolean secureTagContents, String recipientKeyAlias, String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId, String keyPassword)` Uses the XML Security data format
`T`	`serialization()` Uses the Java Serialization data format
`T`	`soapjaxb()` Uses the Soap 1.1 JAXB data format
`T`	`soapjaxb(String contextPath)` Uses the Soap 1.1 JAXB data format
`T`	`soapjaxb(String contextPath, Object elementNameStrategy)` Uses the Soap 1.1 JAXB data format
`T`	`soapjaxb(String contextPath, String elementNameStrategyRef)` Uses the Soap 1.1 JAXB data format
`T`	`soapjaxb12()` Uses the Soap 1.2 JAXB data format
`T`	`soapjaxb12(String contextPath)` Uses the Soap 1.2 JAXB data format
`T`	`soapjaxb12(String contextPath, Object elementNameStrategy)` Uses the Soap JAXB data format
`T`	`soapjaxb12(String contextPath, String elementNameStrategyRef)` Uses the Soap 1.2 JAXB data format
`T`	`string()` Uses the String data format
`T`	`string(String charset)` Uses the String data format supporting encoding using given charset
`T`	`syslog()` Uses the Syslog data format
`T`	`tidyMarkup()` Return TidyMarkup in the default format as `Node`
`T`	`tidyMarkup(Class<?> dataObjectType)` Return WellFormed HTML (an XML Document) either `String` or `Node`
`T`	`xmlBeans()` Uses the xmlBeans data format
`T`	`xmljson()` Uses the xmljson dataformat, based on json-lib
`T`	`xmljson(Map<String,String> options)` Uses the xmljson dataformat, based on json-lib, initializing custom options with a Map
`T`	`xstream()` Uses the XStream data format
`T`	`xstream(String encoding)` Uses the xstream by setting the encoding
`T`	`zip()` Uses the ZIP deflater data format
`T`	`zip(int compressionLevel)` Uses the ZIP deflater data format
`T`	`zipFile()` Uses the ZIP file data format

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataFormatClause

public DataFormatClause(T processorType,
                DataFormatClause.Operation operation)

Method Detail

avro
```
public T avro()
```
Uses the Avro data format

avro
```
public T avro(Object schema)
```

avro

public T avro(String instanceClassName)

base64
```
public T base64()
```
Uses the base64 data format

base64

public T base64(int lineLength,
       String lineSeparator,
       boolean urlSafe)

Uses the base64 data format

beanio

public T beanio(String mapping,
       String streamName)

Uses the beanio data format

beanio

public T beanio(String mapping,
       String streamName,
       String encoding)

Uses the beanio data format

beanio

public T beanio(String mapping,
       String streamName,
       String encoding,
       boolean ignoreUnidentifiedRecords,
       boolean ignoreUnexpectedRecords,
       boolean ignoreInvalidRecords)

Uses the beanio data format

bindy
```
public T bindy(BindyType type,
      String... packages)
```
Uses the Bindy data format

Parameters:
type - the type of bindy data format to use
packages - packages to scan for Bindy annotated POJO classes

bindy
```
public T bindy(BindyType type,
      Class<?> classType)
```
Uses the Bindy data format

Parameters:
type - the type of bindy data format to use
classType - the POJO class type

csv
```
public T csv()
```
Uses the CSV data format

csvLazyLoad
```
public T csvLazyLoad()
```
Uses the CSV data format for a huge file. Sequential access through an iterator.

custom
```
public T custom(String ref)
```
Uses the custom data format

castor
```
public T castor()
```
Uses the Castor data format

castor
```
public T castor(String mappingFile)
```
Uses the Castor data format

Parameters:
mappingFile - name of mapping file to locate in classpath

castor
```
public T castor(String mappingFile,
       boolean validation)
```
Uses the Castor data format

Parameters:
mappingFile - name of mapping file to locate in classpath
validation - whether validation is enabled or not

gzip
```
public T gzip()
```
Uses the GZIP deflater data format

hl7
```
public T hl7()
```
Uses the HL7 data format

hl7
```
public T hl7(boolean validate)
```
Uses the HL7 data format

hl7
```
public T hl7(Object parser)
```
Uses the HL7 data format

pgp

public T pgp(String keyFileName,
    String keyUserid)

Uses the PGP data format

pgp

public T pgp(String keyFileName,
    String keyUserid,
    String password)

Uses the PGP data format

pgp

public T pgp(String keyFileName,
    String keyUserid,
    String password,
    boolean armored,
    boolean integrity)

Uses the PGP data format

jaxb
```
public T jaxb()
```
Uses the JAXB data format

jaxb
```
public T jaxb(String contextPath)
```
Uses the JAXB data format with context path

jaxb
```
public T jaxb(boolean prettyPrint)
```
Uses the JAXB data format turning pretty printing on or off

jibx
```
public T jibx()
```
Uses the JiBX data format.

jibx
```
public T jibx(Class<?> unmarshallClass)
```
Uses the JiBX data format with unmarshall class.

json
```
public T json()
```
Uses the JSON data format using the XStream json library

json
```
public T json(JsonLibrary library)
```
Uses the JSON data format

Parameters:
library - the json library to use

json
```
public T json(JsonLibrary type,
     Class<?> unmarshalType)
```
Uses the JSON data format

Parameters:
type - the json type to use
unmarshalType - unmarshal type for json jackson type

json
```
public T json(Class<?> unmarshalType,
     Class<?> jsonView)
```
Uses the Jackson JSON data format

Parameters:
unmarshalType - unmarshal type for json jackson type
jsonView - the view type for json jackson type

json
```
public T json(Class<?> unmarshalType,
     Class<?> jsonView,
     String include)
```
Uses the Jackson JSON data format

Parameters:
unmarshalType - unmarshal type for json jackson type
jsonView - the view type for json jackson type
include - include such as ALWAYS, NON_NULL, etc.

protobuf
```
public T protobuf()
```
Uses the protobuf data format

protobuf

public T protobuf(Object defaultInstance)

protobuf

public T protobuf(String instanceClassName)

rss
```
public T rss()
```
Uses the RSS data format

serialization
```
public T serialization()
```
Uses the Java Serialization data format

soapjaxb
```
public T soapjaxb()
```
Uses the Soap 1.1 JAXB data format

soapjaxb

public T soapjaxb(String contextPath)

Uses the Soap 1.1 JAXB data format

soapjaxb

public T soapjaxb(String contextPath,
         String elementNameStrategyRef)

Uses the Soap 1.1 JAXB data format

soapjaxb

public T soapjaxb(String contextPath,
         Object elementNameStrategy)

Uses the Soap 1.1 JAXB data format

soapjaxb12
```
public T soapjaxb12()
```
Uses the Soap 1.2 JAXB data format

soapjaxb12

public T soapjaxb12(String contextPath)

Uses the Soap 1.2 JAXB data format

soapjaxb12

public T soapjaxb12(String contextPath,
           String elementNameStrategyRef)

Uses the Soap 1.2 JAXB data format

soapjaxb12

public T soapjaxb12(String contextPath,
           Object elementNameStrategy)

Uses the Soap JAXB data format

string
```
public T string()
```
Uses the String data format

string
```
public T string(String charset)
```
Uses the String data format supporting encoding using given charset

syslog
```
public T syslog()
```
Uses the Syslog data format

tidyMarkup
```
public T tidyMarkup(Class<?> dataObjectType)
```
Return WellFormed HTML (an XML Document) either String or Node

tidyMarkup
```
public T tidyMarkup()
```
Return TidyMarkup in the default format as Node

xstream
```
public T xstream()
```
Uses the XStream data format

xstream
```
public T xstream(String encoding)
```
Uses the xstream by setting the encoding

secureXML
```
public T secureXML()
```
Uses the XML Security data format