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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hector-object-mapper Show documentation

There is a newer version: 3.0-04

package me.prettyprint.hom.annotations;

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

import me.prettyprint.hom.converters.Converter;
import me.prettyprint.hom.converters.DefaultConverter;


/**
 * Annotation for specifying which POJO properties should be mapped to Cassandra
 * columns. Must specify "name" as the column name in Cassandra.
 * 
 * @author
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Column {

  /**
   * The Cassandra column name.
   * 
   * @return name of column
   */
  String name();

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

}