me.prettyprint.hom.annotations.Id Maven / Gradle / Ivy

Go to download
package me.prettyprint.hom.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import me.prettyprint.hom.converters.Converter;


/**
 * Annotation marking the ID property in the POJO. Marking the ID property is
 * required so the object mapper can get/set the ID (Cassandra row key) in the
 * POJO.
 * 
 * @author Todd Burruss
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface Id {

  /**
   * The optional converter to use when converting POJO property value to/from
   * byte[]. If not specified, {@link me.prettyprint.hom.converters.DefaultConverter} is used.
   * 
   * @return Class of converter
   */
  Class converter() default me.prettyprint.hom.converters.DefaultConverter.class;

}