Package org.springframework.data.cassandra.core.mapping

Annotation Interface CassandraType

@Documented
@Retention(RUNTIME)
@Target({TYPE,TYPE_PARAMETER,ANNOTATION_TYPE,FIELD,METHOD,PARAMETER})
public @interface CassandraType

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

Author:

Alex Shvid, Matthew T. Adams, Mark Paluch

See Also:

• CassandraType.Name

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CassandraType.Name	Cassandra Protocol types.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
CassandraType.Name	type	The CassandraType.Name of the property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
CassandraType.Name[]	typeArguments	If the property is Collection-like, then this attribute holds a single DataType Name representing the element type of the Collection.
String	userTypeName	If the property maps to a User-Defined Type (UDT) then this attribute holds the user type name.

Element Details

type

CassandraType.Name type

The CassandraType.Name of the property.

typeArguments

CassandraType.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 a 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 nor a Map, then this attribute is ignored.

Returns:

an array of CassandraType.Name objects.

See Also:

• CassandraType.Name

Default:

{}

userTypeName

String userTypeName

If the property maps to a User-Defined Type (UDT) then this attribute holds the user type name. For Collection-like properties the user type name applies to the component type. For Map properties, typeArguments() configured to CassandraType.Name.UDT are resolved using the user type name. 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:

""