com.datastax.driver.mapping.annotations.Field Maven / Gradle / Ivy
Show all versions of scylla-driver-mapping Show documentation
/*
* Copyright DataStax, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.datastax.driver.mapping.annotations;
import com.datastax.driver.core.TypeCodec;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation that allows to specify the name of the CQL UDT field to which the Java field or bean
* property should be mapped.
*
* Note that this annotation is generally optional in the sense that any field or any getter
* method of a Java bean property of a class annotated by {@link UDT} will be mapped by default to a
* UDT field having the same name than this Java field / bean property unless that Java field or
* method has the {@link Transient} annotation. As such, this annotation is mainly useful when the
* UDT field name does not correspond to the Java field or property name itself.
*/
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Field {
/**
* Name of the column being mapped in Cassandra. By default, the name of the Java field or bean
* property will be used.
*
* @return the name of the mapped column in Cassandra, or {@code ""} to use the field name.
*/
String name() default "";
/**
* Whether the column name is a case sensitive one.
*
* @return whether the column name is a case sensitive one.
*/
boolean caseSensitive() default false;
/**
* A custom codec that will be used to serialize and deserialize the column.
*
* @return the codec's class. It must have a no-argument constructor (the mapper will create an
* instance and cache it).
*/
Class> codec() default Defaults.NoCodec.class;
}