com.datastax.oss.driver.api.mapper.annotations.PropertyStrategy Maven / Gradle / Ivy
/*
* 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.oss.driver.api.mapper.annotations;
import com.datastax.oss.driver.api.mapper.entity.naming.GetterStyle;
import com.datastax.oss.driver.api.mapper.entity.naming.SetterStyle;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotates an {@link Entity} to customize certain aspects of the introspection process that
* determines which methods are considered as properties, and how new instances will be created.
*
* Example:
*
*
* @Entity
* @PropertyStrategy(getterStyle = FLUENT)
* public class Account {
* ...
* }
*
*
* This annotation can be inherited from an interface or parent class.
*
* When neither the entity class nor any of its parent is explicitly annotated, the mapper will
* assume context-dependent defaults:
*
*
* - for a Scala case class: {@code mutable = false} and {@code getterStyle = FLUENT}. The
* mapper detects this case by checking if the entity implements {@code scala.Product}.
*
- for a Kotlin data class: {@code mutable = false} and {@code getterStyle = JAVABEANS}. The
* mapper detects this case by checking if the entity is annotated with {@code
* kotlin.Metadata}, and if it has any method named {@code component1} (both of these are
* added automatically by the Kotlin compiler).
*
- Java records (JDK 14 and above): {@code mutable = false} and {@code getterStyle = FLUENT}.
* The mapper detects this case by checking if the entity extends {@code java.lang.Record}.
*
- any other case: {@code mutable = true}, {@code getterStyle = JAVABEANS} and {@code
* setterStyle = JAVABEANS}.
*
*
* Not that this only applies if the annotation is completely absent. If it is present with only
* some of its attributes, the remaining attributes will get the default declared by the annotation,
* not the context-dependent default above (for example, if a Kotlin data class is annotated with
* {@code @PropertyStrategy(getterStyle = FLUENT)}, it will be mutable).
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface PropertyStrategy {
/** The style of getter. See {@link GetterStyle} and its constants for more explanations. */
GetterStyle getterStyle() default GetterStyle.JAVABEANS;
/**
* The style of setter. See {@link SetterStyle} and its constants for more explanations.
*
* This has no effect if {@link #mutable()} is false.
*/
SetterStyle setterStyle() default SetterStyle.JAVABEANS;
/**
* Whether the entity is mutable.
*
*
If this is set to false:
*
*
* - the mapper won't try to discover setters for the properties;
*
- it will assume that the entity class has a visible constructor that takes all the
* non-transient properties as arguments.
*
*/
boolean mutable() default true;
}