Interface DataFormatCustomizer

All Superinterfaces:

Ordered

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface DataFormatCustomizer
extends Ordered

Strategy for applying custom configuration to DataFormat instances as they are created.

Customizers are discovered from the Registry and applied to each data format during bootstrap, with isEnabled(String, DataFormat) (and an optional DataFormatCustomizer.Policy) deciding whether a given data format is customized, and Ordered controlling the order. Use the builder() / forType(Class, ThrowingConsumer) helpers to target a concrete data format type. This is the data-format-level counterpart to CamelContextCustomizer.

See CamelContext auto-configuration in the Camel user manual.

See Also:

• CamelContextCustomizer
• ComponentCustomizer
• LanguageCustomizer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DataFormatCustomizer.Builder<T extends DataFormat>	A fluent builder to create a DataFormatCustomizer instance.
static interface	DataFormatCustomizer.Policy	Used as additional filer mechanism to control if customizers need to be applied or not.

Field Summary

Fields inherited from interface Ordered

HIGHEST, LOWEST

Method Summary

Modifier and Type	Method	Description
static DataFormatCustomizer.Builder<DataFormat>	builder()	Create a generic DataFormatCustomizer.Builder.
static <T extends DataFormat> DataFormatCustomizer.Builder<T>	builder(Class<T> type)	Create a typed DataFormatCustomizer.Builder that can process a concrete data format type instance.
void	configure(String name, DataFormat target)	Customize the specified DataFormat.
static <T extends DataFormat> DataFormatCustomizer	forType(Class<T> type, org.apache.camel.util.function.ThrowingConsumer<T, Exception> consumer)	Create a DataFormatCustomizer that can process a concrete data format type instance.
default int	getOrder()	Gets the order.
default boolean	isEnabled(String name, DataFormat target)	Checks whether this customizer should be applied to the given DataFormat.

Method Details

builder

static DataFormatCustomizer.Builder<DataFormat> builder()

Create a generic DataFormatCustomizer.Builder.

Returns:

the DataFormatCustomizer.Builder

builder

static <T extends DataFormat>
DataFormatCustomizer.Builder<T> builder(Class<T> type)

Create a typed DataFormatCustomizer.Builder that can process a concrete data format type instance.

Parameters:

type - the concrete type of the Component

Returns:

the ComponentCustomizer.Builder

forType

static <T extends DataFormat> DataFormatCustomizer forType(Class<T> type,
 org.apache.camel.util.function.ThrowingConsumer<T, Exception> consumer)

Create a DataFormatCustomizer that can process a concrete data format type instance.

Parameters:

type - the concrete type of the DataFormat

consumer - the DataFormat configuration logic

Returns:

the DataFormatCustomizer

configure

void configure(String name,
 DataFormat target)

Customize the specified DataFormat.

Parameters:

name - the unique name of the data format

target - the data format to configure

isEnabled

default boolean isEnabled(String name,
 DataFormat target)

Checks whether this customizer should be applied to the given DataFormat.

Parameters:

name - the unique name of the data format

target - the data format to configure

Returns:

true if the customizer should be applied

getOrder

default int getOrder()

Description copied from interface: Ordered

Gets the order.

Use low numbers for higher priority. Normally the sorting will start from 0 and move upwards. So if you want to be last then use Integer.MAX_VALUE or eg Ordered.LOWEST.

Specified by:

getOrder in interface Ordered

Returns:

the order