com.datastax.driver.mapping.annotations

Annotation Type Field

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface Field

Annotation that allows to specify the name of the CQL UDT field to which the Java field should be mapped.

Note that this annotation is generally optional in the sense that any field of a class annotated by UDT will be mapped by default to a UDT field having the same name than this Java field unless that Java field has the Transient annotation. As such, this annotation is mainly useful when the name to map the field to is not the same one that the field itself (but can be added without it's name parameter for documentation sake).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	caseSensitive Whether the column name is a case sensitive one.
Class<? extends TypeCodec<?>>	codec A custom codec that will be used to serialize and deserialize the column.
String	name Name of the column being mapped in Cassandra.

Element Detail

name

public abstract String name

Name of the column being mapped in Cassandra. By default, the name of the field will be used.

Returns:

the name of the mapped column in Cassandra, or "" to use the field name.

Default:

""

caseSensitive

public abstract boolean caseSensitive

Whether the column name is a case sensitive one.

Returns:

whether the column name is a case sensitive one.

Default:

false

codec

public abstract Class<? extends TypeCodec<?>> codec

A custom codec that will be used to serialize and deserialize the column.

Returns:

the codec's class. It must have a no-argument constructor (the mapper will create an instance and cache it).

Default:

com.datastax.driver.mapping.annotations.Defaults.NoCodec.class