Interface LanguageCustomizer

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 LanguageCustomizer
extends Ordered

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

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

See CamelContext auto-configuration in the Camel user manual.

See Also:

• CamelContextCustomizer
• ComponentCustomizer
• DataFormatCustomizer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LanguageCustomizer.Builder<T extends Language>	A fluent builder to create a LanguageCustomizer instance.
static interface	LanguageCustomizer.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 LanguageCustomizer.Builder<Language>	builder()	Create a generic LanguageCustomizer.Builder.
static <T extends Language> LanguageCustomizer.Builder<T>	builder(Class<T> type)	Create a typed LanguageCustomizer.Builder that can process a concrete language type instance.
void	configure(String name, Language target)	Customize the specified Language.
static <T extends Language> LanguageCustomizer	forType(Class<T> type, org.apache.camel.util.function.ThrowingConsumer<T, Exception> consumer)	Create a DataFormatCustomizer that can process a concrete language type instance.
default int	getOrder()	Gets the order.
default boolean	isEnabled(String name, Language target)	Checks whether this customizer should be applied to the given Language.

Method Details

builder

static LanguageCustomizer.Builder<Language> builder()

Create a generic LanguageCustomizer.Builder.

Returns:

the LanguageCustomizer.Builder

builder

static <T extends Language>
LanguageCustomizer.Builder<T> builder(Class<T> type)

Create a typed LanguageCustomizer.Builder that can process a concrete language type instance.

Parameters:

type - the concrete type of the Component

Returns:

the ComponentCustomizer.Builder

forType

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

Create a DataFormatCustomizer that can process a concrete language type instance.

Parameters:

type - the concrete type of the Language

consumer - the Language configuration logic

Returns:

the LanguageCustomizer

configure

void configure(String name,
 Language target)

Customize the specified Language.

Parameters:

name - the unique name of the language

target - the language to configure

isEnabled

default boolean isEnabled(String name,
 Language target)

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

Parameters:

name - the unique name of the language

target - the language 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