org.springframework.data.cassandra.core.mapping

Annotation Type CassandraType

@Documented
 @Retention(value=RUNTIME)
public @interface CassandraType

Specifies the Cassandra type of the annotated property or parameter if used in query methods.

Author:

Alex Shvid, Matthew T. Adams, Mark Paluch

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
com.datastax.driver.core.DataType.Name	type The DataType.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
com.datastax.driver.core.DataType.Name[]	typeArguments If the property is collection-like, then this attribute holds a single DataType.
String	userTypeName If the property maps to a user-defined type then this attribute holds the user type name.

Element Detail

type

public abstract com.datastax.driver.core.DataType.Name type

The DataType.Name of the property.

typeArguments

public abstract com.datastax.driver.core.DataType.Name[] typeArguments

If the property is collection-like, then this attribute holds a single DataType.Name, representing the element type of the collection.

If the property is map, then this attribute holds exactly two DataType.Names: the first is the key type, and the second is the value type.

If the property is neither collection-like or a map, then this attribute is ignored.

Default:

{}

userTypeName

public abstract String userTypeName

If the property maps to a user-defined type then this attribute holds the user type name. For collection-like properties the user type name applies to the component type. The user type name is only required if the UDT does not map to a class annotated with UserDefinedType.

Returns:

name of the user type

Since:

1.5

Default:

""