info.archinnov.achilles.annotations

Annotation Type CodecRegistry

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface CodecRegistry

Marker annotation to be used on configuration class for compile-time code generation. The type (class, abstract class or interface) having this annotation will expose a list of codecs to be used by Achilles during source code parsing.
Usage:

 public class MyOwnType {...}
 @CodecRegistry
 public [class | abstract class | interface] MyCodecRegistry {

      //Source type = int, target type = String (according to IntToStringCodec codec)
      @Codec(IntToStringCodec.class)
      private int intToString;

      //Source type = MyOwnType, target type = String (according to MyOwnTypeToStringCodec codec)
      @Codec(MyOwnTypeToStringCodec.class)
      private MyOwnType myOwnTypeToString;

      //Source type = AnotherBean, target type = String (because of @JSON)
      @JSON
      private AnotherBean beanToJSON;

      //Source type = MyEnum, target type = int (because of Encoding.ORDINAL)
      @Enumerated(Encoding.ORDINAL)
      private MyEnum enumToOrdinal;
 }
 

Note: it is possible to declare several codec registries in your source code, just annotate them with @CodecRegistry

Warning: it is not possible to declare 2 different codecs for the same source type for all registered codec registries. Achilles will raise a compilation error when encountering such case. Ex:

 @CodecRegistry
 public class MyCodecRegistry {

      @Codec(MyOwnTypeToStringCodec.class)
      private MyOwnType myOwnTypeToString;

      // ERROR, not possible to have a 2nd codec for the same source type MyOwnType
      @Codec(MyOwnTypeToBytesCodec.class)
      private MyOwnType myOwnTypeToBytes;
 }
 

See Also:

Codec Registry