info.archinnov.achilles.annotations

Annotation Type RuntimeCodec

@Retention(value=RUNTIME)
 @Target(value={FIELD,TYPE_USE,TYPE_PARAMETER})
 @Documented
public @interface RuntimeCodec

Transform a custom Java type into one of native types supported by the Java driver. Normally you'll use the @Codec annotation and provide a codec class but if your codec class is stateful or its construction needs some external dependencies and cannot be instantiated using the default no-args constructor, you can register the codec using this annotation and build it at runtime before injecting it into Achilles
Ex:

 //Compile time
 @Column
 @RuntimeCodec(cqlClass = String.class)
 private MyBean bean;

 //Runtime
 final Cluster cluster = .... // Create Java driver cluster object
 final Codec<MyBean, String> statefulCodec = new .... // Create your codec with initialization logic here
 final CodecSignature<MyBean, String> codecSignature = new CodecSignature(MyBean.class, String.class);

 ManagerFactory factory = ManagerFactoryBuilder
                              .builder(cluster)
                              ...
                              .withRuntimeCodec(codecSignature, codec)
                              .build();

 

See Also:

Runtime Codec

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	cqlClass Mandatory.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	codecName To help Achilles look up for your codec at bootstrap time and distinguish it from other codecs having same source and target types, you can provide an unique name here

Element Detail

cqlClass

public abstract Class<?> cqlClass

Mandatory. To help Achilles determine the CQL type at compile time, you have to specify the target Cassandra Java data type. This type should be a CQL-compatible type.

codecName

public abstract String codecName

To help Achilles look up for your codec at bootstrap time and distinguish it from other codecs having same source and target types, you can provide an unique name here

Default:

""