Package io.micronaut.serde.config.annotation

Annotation Interface SerdeConfig

@Internal
@Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
@Inherited
public @interface SerdeConfig

Meta-annotation with meta annotation members that different annotation models can be bind to.

This annotation shouldn't be used directly instead a concrete annotation API for JSON like JSON-B or Jackson annotations should be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	SerdeConfig.SerAnyGetter	Internal metadata for a JSON any getter.
static @interface	SerdeConfig.SerAnySetter	Internal metadata for any setter.
static @interface	SerdeConfig.SerBackRef	Back reference.
static enum	SerdeConfig.SerCreatorMode	Creator mode used when invoking the Creator.
static @interface	SerdeConfig.SerError	Used to store errors.
static @interface	SerdeConfig.SerGetter	Internal metadata for a JSON getter.
static @interface	SerdeConfig.SerIgnored	Ignore handling meta annotation.
static enum	SerdeConfig.SerInclude	Include strategies for serialization.
static @interface	SerdeConfig.SerIncluded	Include property meta annotation.
static @interface	SerdeConfig.SerManagedRef	Managed reference.
static @interface	SerdeConfig.SerSetter	Internal metadata for a setter.
static @interface	SerdeConfig.SerSubtyped	Meta annotations for subtyped mapping.
static @interface	SerdeConfig.SerUnwrapped	Internal metadata type for wrapped settings.
static @interface	SerdeConfig.SerValue	Meta-annotation used to model the value used during serialization.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIASES	Aliases for deserialization.
static final String	ARRAY_WRAPPER_PROPERTY	A property that should be used as a first item and the value as the second in the array wrap when serializing.
static final String	DESERIALIZE_AS	Used to store the type that will deserialize this type.
static final String	DESERIALIZER_CLASS	Custom deserializer class.
static final String	FILTER	Property filter name.
static final String	IGNORED	Is it ignored.
static final String	IGNORED_DESERIALIZATION	Is it ignored for deserialization.
static final String	IGNORED_SERIALIZATION	Is it ignored for serialization.
static final String	INCLUDE	Include strategy.
static final String	LENIENT	if parsing is required whether to be lenient.
static final String	LOCALE	A locale to use.
static final String	META_ANNOTATION_PROPERTY	The meta annotation for property.
static final String	META_ANNOTATION_PROPERTY_ORDER	The meta annotation for property order.
static final String	NAMING	Naming strategy.
static final String	PATTERN	A pattern to use.
static final String	PROPERTY	The property to use.
static final String	READ_ONLY	Is this property to be used only for reading.
static final String	REQUIRED	Whether this property is required (must be present in the input).
static final String	RUNTIME_NAMING	Runtime naming strategy class.
static final String	SERIALIZE_AS	Used to store the type that will serialize this type.
static final String	SERIALIZER_CLASS	Custom serializer class.
static final String	TIMEZONE	A time zone to use.
static final String	TYPE_DISCRIMINATOR_TYPE	The type discriminator type.
static final String	TYPE_NAME	A type name mapping.
static final String	TYPE_NAME_CLASS_SIMPLE_NAME_PLACEHOLDER	A type name mapping.
static final String	TYPE_NAMES	A type name mapping used for subtype binding with multiple names.
static final String	TYPE_PROPERTY	The type property used for subtype binding.
static final String	TYPE_PROPERTY_VISIBLE	If the type property should be visible.
static final String	VALIDATE	Whether to validate at compilation time the config.
static final String	VIEWS	The views an element is part of.
static final String	WRAPPER_PROPERTY	A property that should be used to wrap this value when serializing.
static final String	WRITE_ONLY	Is this property to be used only for writing.

Field Details

META_ANNOTATION_PROPERTY

static final String META_ANNOTATION_PROPERTY

The meta annotation for property.

See Also:

• Constant Field Values

META_ANNOTATION_PROPERTY_ORDER

static final String META_ANNOTATION_PROPERTY_ORDER

The meta annotation for property order.

See Also:

• Constant Field Values

SERIALIZE_AS

static final String SERIALIZE_AS

Used to store the type that will serialize this type.

See Also:

• Constant Field Values

DESERIALIZE_AS

static final String DESERIALIZE_AS

Used to store the type that will deserialize this type.

See Also:

• Constant Field Values

VALIDATE

static final String VALIDATE

Whether to validate at compilation time the config.

See Also:

• Constant Field Values

PROPERTY

static final String PROPERTY

The property to use.

See Also:

• Constant Field Values

REQUIRED

static final String REQUIRED

Whether this property is required (must be present in the input).

See Also:

• Constant Field Values

IGNORED

static final String IGNORED

Is it ignored.

See Also:

• Constant Field Values

IGNORED_DESERIALIZATION

static final String IGNORED_DESERIALIZATION

Is it ignored for deserialization.

See Also:

• Constant Field Values

IGNORED_SERIALIZATION

static final String IGNORED_SERIALIZATION

Is it ignored for serialization.

See Also:

• Constant Field Values

INCLUDE

static final String INCLUDE

Include strategy.

See Also:

• Constant Field Values

FILTER

static final String FILTER

Property filter name.

See Also:

• Constant Field Values

READ_ONLY

static final String READ_ONLY

Is this property to be used only for reading.

See Also:

• Constant Field Values

WRITE_ONLY

static final String WRITE_ONLY

Is this property to be used only for writing.

See Also:

• Constant Field Values

TYPE_NAME

static final String TYPE_NAME

A type name mapping. Used for subtype binding. The type name to be used during serialization.

See Also:

• Constant Field Values

TYPE_NAMES

static final String TYPE_NAMES

A type name mapping used for subtype binding with multiple names. All the names would be mapped to the class during deserialization.

See Also:

• Constant Field Values

TYPE_NAME_CLASS_SIMPLE_NAME_PLACEHOLDER

static final String TYPE_NAME_CLASS_SIMPLE_NAME_PLACEHOLDER

A type name mapping. Used for subtype binding.

See Also:

• Constant Field Values

TYPE_PROPERTY

static final String TYPE_PROPERTY

The type property used for subtype binding.

See Also:

• Constant Field Values

TYPE_DISCRIMINATOR_TYPE

static final String TYPE_DISCRIMINATOR_TYPE

The type discriminator type.

See Also:

• Constant Field Values

TYPE_PROPERTY_VISIBLE

static final String TYPE_PROPERTY_VISIBLE

If the type property should be visible.

See Also:

• Constant Field Values

WRAPPER_PROPERTY

static final String WRAPPER_PROPERTY

A property that should be used to wrap this value when serializing.

See Also:

• Constant Field Values

ARRAY_WRAPPER_PROPERTY

static final String ARRAY_WRAPPER_PROPERTY

A property that should be used as a first item and the value as the second in the array wrap when serializing.

See Also:

• Constant Field Values

PATTERN

static final String PATTERN

A pattern to use.

See Also:

• Constant Field Values

LOCALE

static final String LOCALE

A locale to use.

See Also:

• Constant Field Values

TIMEZONE

static final String TIMEZONE

A time zone to use.

See Also:

• Constant Field Values

LENIENT

static final String LENIENT

if parsing is required whether to be lenient.

See Also:

• Constant Field Values

SERIALIZER_CLASS

static final String SERIALIZER_CLASS

Custom serializer class.

See Also:

• Constant Field Values

DESERIALIZER_CLASS

static final String DESERIALIZER_CLASS

Custom deserializer class.

See Also:

• Constant Field Values

VIEWS

static final String VIEWS

The views an element is part of.

See Also:

• Constant Field Values

ALIASES

static final String ALIASES

Aliases for deserialization.

See Also:

• Constant Field Values

NAMING

static final String NAMING

Naming strategy.

See Also:

• Constant Field Values

RUNTIME_NAMING

static final String RUNTIME_NAMING

Runtime naming strategy class.

See Also:

• Constant Field Values