org.apache.camel.spi

Annotation Type Metadata

@Retention(value=RUNTIME)
 @Documented
 @Target(value={TYPE,METHOD,FIELD})
public @interface Metadata

Meta data for EIPs, components, data formats and other Camel concepts

For example to associate labels to Camel components

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue To define a default value.
String	deprecationNote Additional description that can explain the user about the deprecation and give reference to what to use instead.
String	description Returns a description of this entity.
String	displayName A human display name of the parameter.
String	enums Allows to define enums this options accepts.
String	firstVersion The first version this functionality was added to Apache Camel.
String	javaType To re-associate the preferred Java type of this parameter.
String	label To define one or more labels.
boolean	required To define that this entity is required.
boolean	secret Whether the option is secret/sensitive information such as a password.
boolean	skip Whether to skip this option
String	title An optional human readable title of this entity, to be used instead of a computed title.

Element Detail

displayName

public abstract String displayName

A human display name of the parameter.

This is used for documentation and tooling only.

Default:

""

label

public abstract String label

To define one or more labels.

Multiple labels can be defined as a comma separated value.

Default:

""

defaultValue

public abstract String defaultValue

To define a default value.

Default:

""

required

public abstract boolean required

To define that this entity is required.

Default:

false

title

public abstract String title

An optional human readable title of this entity, to be used instead of a computed title.

Default:

""

description

public abstract String description

Returns a description of this entity.

This is used for documentation and tooling only.

Default:

""

enums

public abstract String enums

Allows to define enums this options accepts.

If the type is already an enum, then this option should not be used; instead you can use this option when the type is a String that only accept certain values.

Multiple values is separated by comma.

Default:

""

secret

public abstract boolean secret

Whether the option is secret/sensitive information such as a password.

Default:

false

javaType

public abstract String javaType

To re-associate the preferred Java type of this parameter.

This is used for parameters which are of a specialized type but can be configured by another Java type, such as from a String.

Default:

""

firstVersion

public abstract String firstVersion

The first version this functionality was added to Apache Camel.

Default:

""

deprecationNote

public abstract String deprecationNote

Additional description that can explain the user about the deprecation and give reference to what to use instead.

Default:

""

skip

public abstract boolean skip

Whether to skip this option

Default:

false