CBORDataFormat (Camel :: Core Engine 3.0.0-RC2 API)

java.lang.Object
- org.apache.camel.model.IdentifiedType
- - org.apache.camel.model.DataFormatDefinition
  - - org.apache.camel.model.dataformat.CBORDataFormat

All Implemented Interfaces:

DefinitionPropertyPlaceholderConfigurer, OtherAttributesAware, org.apache.camel.spi.PropertyConfigurer, org.apache.camel.spi.PropertyPlaceholderConfigurer
```
@Metadata(firstVersion="3.0.0",
          label="dataformat,transformation,json",
          title="CBOR")
public class CBORDataFormat
extends DataFormatDefinition
```
CBOR data format is used for unmarshal a CBOR payload to POJO or to marshal POJO back to CBOR payload.

Constructor Summary

Constructors
Constructor and Description

CBORDataFormat()

Constructors
Constructor and Description
`CBORDataFormat()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAllowJmsType()`
`Boolean`	`getAllowUnmarshallType()`
`Class<?>`	`getCollectionType()`
`String`	`getCollectionTypeName()`
`String`	`getDataFormatName()`
`String`	`getDisableFeatures()`
`String`	`getEnableFeatures()`
`String`	`getObjectMapper()`
`Boolean`	`getPrettyPrint()`
`Class<?>`	`getUnmarshalType()`
`String`	`getUnmarshalTypeName()`
`Boolean`	`getUseDefaultObjectMapper()`
`Boolean`	`getUseList()`
`void`	`setAllowJmsType(Boolean allowJmsType)` Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.
`void`	`setAllowUnmarshallType(Boolean allowUnmarshallType)` If enabled then Jackson CBOR is allowed to attempt to use the CamelCBORUnmarshalType header during the unmarshalling.
`void`	`setCollectionType(Class<?> collectionType)`
`void`	`setCollectionTypeName(String collectionTypeName)` Refers to a custom collection type to lookup in the registry to use.
`void`	`setDisableFeatures(String disableFeatures)` Set of features to disable on the Jackson `com.fasterxml.jackson.databind.ObjectMapper`.
`void`	`setEnableFeatures(String enableFeatures)` Set of features to enable on the Jackson `com.fasterxml.jackson.databind.ObjectMapper`.
`void`	`setObjectMapper(String objectMapper)` Lookup and use the existing CBOR ObjectMapper with the given id when using Jackson.
`void`	`setPrettyPrint(Boolean prettyPrint)` To enable pretty printing output nicely formatted.
`void`	`setUnmarshalType(Class<?> unmarshalType)` Class of the java type to use when unarmshalling
`void`	`setUnmarshalTypeName(String unmarshalTypeName)` Class name of the java type to use when unarmshalling
`void`	`setUseDefaultObjectMapper(Boolean useDefaultObjectMapper)` Whether to lookup and use default Jackson CBOR ObjectMapper from the registry.
`void`	`setUseList(Boolean useList)` To unarmshal to a List of Map or a List of Pojo.

Methods inherited from class org.apache.camel.model.DataFormatDefinition
getContentTypeHeader, getDataFormat, getOtherAttributes, getShortName, setContentTypeHeader, setDataFormat, setDataFormatName, setOtherAttributes

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

Methods inherited from interface org.apache.camel.model.DefinitionPropertyPlaceholderConfigurer
getReadPropertyPlaceholderOptions, getWritePropertyPlaceholderOptions

- Constructor Detail
  - CBORDataFormat
```
public CBORDataFormat()
```
- Method Detail
  - getObjectMapper
```
public String getObjectMapper()
```
  - setObjectMapper
```
public void setObjectMapper(String objectMapper)
```
    Lookup and use the existing CBOR ObjectMapper with the given id when using Jackson.
  - getUseDefaultObjectMapper
```
public Boolean getUseDefaultObjectMapper()
```
  - setUseDefaultObjectMapper
```
public void setUseDefaultObjectMapper(Boolean useDefaultObjectMapper)
```
    Whether to lookup and use default Jackson CBOR ObjectMapper from the registry.
  - getUnmarshalTypeName
```
public String getUnmarshalTypeName()
```
  - setUnmarshalTypeName
```
public void setUnmarshalTypeName(String unmarshalTypeName)
```
    Class name of the java type to use when unarmshalling
  - getUnmarshalType
```
public Class<?> getUnmarshalType()
```
  - getPrettyPrint
```
public Boolean getPrettyPrint()
```
  - setPrettyPrint
```
public void setPrettyPrint(Boolean prettyPrint)
```
    To enable pretty printing output nicely formatted.
    Is by default false.
  - getAllowJmsType
```
public Boolean getAllowJmsType()
```
  - setAllowJmsType
```
public void setAllowJmsType(Boolean allowJmsType)
```
    Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.
  - setUnmarshalType
```
public void setUnmarshalType(Class<?> unmarshalType)
```
    Class of the java type to use when unarmshalling
  - getCollectionTypeName
```
public String getCollectionTypeName()
```
  - setCollectionTypeName
```
public void setCollectionTypeName(String collectionTypeName)
```
    Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default.
  - getCollectionType
```
public Class<?> getCollectionType()
```
  - setCollectionType
```
public void setCollectionType(Class<?> collectionType)
```
  - getUseList
```
public Boolean getUseList()
```
  - setUseList
```
public void setUseList(Boolean useList)
```
    To unarmshal to a List of Map or a List of Pojo.
  - getAllowUnmarshallType
```
public Boolean getAllowUnmarshallType()
```
  - setAllowUnmarshallType
```
public void setAllowUnmarshallType(Boolean allowUnmarshallType)
```
    If enabled then Jackson CBOR is allowed to attempt to use the CamelCBORUnmarshalType header during the unmarshalling.
    This should only be enabled when desired to be used.
  - getEnableFeatures
```
public String getEnableFeatures()
```
  - setEnableFeatures
```
public void setEnableFeatures(String enableFeatures)
```
    Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper.
    The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature
    Multiple features can be separated by comma
  - getDisableFeatures
```
public String getDisableFeatures()
```
  - setDisableFeatures
```
public void setDisableFeatures(String disableFeatures)
```
    Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper.
    The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature
    Multiple features can be separated by comma
  - getDataFormatName
```
public String getDataFormatName()
```
    Overrides:
    
    getDataFormatName in class DataFormatDefinition

Class CBORDataFormat

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.camel.model.DefinitionPropertyPlaceholderConfigurer

Constructor Detail

CBORDataFormat

Method Detail

getObjectMapper

setObjectMapper

getUseDefaultObjectMapper

setUseDefaultObjectMapper

getUnmarshalTypeName

setUnmarshalTypeName

getUnmarshalType

getPrettyPrint

setPrettyPrint

getAllowJmsType

setAllowJmsType

setUnmarshalType

getCollectionTypeName

setCollectionTypeName

getCollectionType

setCollectionType

getUseList

setUseList

getAllowUnmarshallType

setAllowUnmarshallType

getEnableFeatures

setEnableFeatures

getDisableFeatures

setDisableFeatures

getDataFormatName