io.micronaut.serde.annotation

Annotation Type SerdeImport

@Internal
 @Target(value=TYPE)
 @Retention(value=SOURCE)
 @Repeatable(value=SerdeImport.Repeated.class)
public @interface SerdeImport

Annotation to allow external classes to be enabled for serialization / deserialization.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.Class<?>	value Allows making an external class or interface serializable.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	deserializable
java.lang.Class<?>	mixin Apply a mixin type.
boolean	serializable

Element Detail

value

public abstract java.lang.Class<?> value

Allows making an external class or interface serializable.

Note that mixins only work with publicly accessible members (constructors, getters/setters etc.), anything not public will not be includes in the serialization/deserialization result.

Returns:

The type to enable serialization for.

mixin

public abstract java.lang.Class<?> mixin

Apply a mixin type. This is equivalent to Jackson objectMapper.addMixInAnnotations(..) allowing to mixin the annotations to the imported type.

Any fields or methods that match fields or methods declared in the type specified to value() will have the annotations applied to the imported type.

Returns:

The mixin type

Default:

void.class

serializable

public abstract boolean serializable

Returns:

Whether to import for serialization. Defaults to true.

Default:

true

deserializable

public abstract boolean deserializable

Returns:

Whether to import for deserialization. Defaults to true.

Default:

true