com.datastax.driver.mapping

Enum PropertyTransienceStrategy

java.lang.Object

java.lang.Enum<PropertyTransienceStrategy>

com.datastax.driver.mapping.PropertyTransienceStrategy

All Implemented Interfaces:

Serializable, Comparable<PropertyTransienceStrategy>

public enum PropertyTransienceStrategy
extends Enum<PropertyTransienceStrategy>

A strategy to determine which properties are transient, and which aren't.

Transient properties will be ignored, whereas non-transient ones will be mapped.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OPT_IN This strategy adopts a conservative, opt-in approach that only considers a property to be non-transient if it is explicitly annotated with one of the following annotations: Column Computed ClusteringColumn Frozen FrozenKey FrozenValue PartitionKey Field
OPT_OUT This strategy adopts a permissive, opt-out approach that will consider a property to be non-transient by default, unless: The property is annotated with @Transient; The corresponding field is non-null and is marked with the keyword transient; The property name has been explicitly black-listed (see DefaultPropertyMapper.setTransientPropertyNames(Set)).

Method Summary

Modifier and Type	Method and Description
static PropertyTransienceStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropertyTransienceStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPT_OUT

public static final PropertyTransienceStrategy OPT_OUT

This strategy adopts a permissive, opt-out approach that will consider a property to be non-transient by default, unless:

1. The property is annotated with @Transient;
2. The corresponding field is non-null and is marked with the keyword transient;
3. The property name has been explicitly black-listed (see DefaultPropertyMapper.setTransientPropertyNames(Set)).

OPT_IN

public static final PropertyTransienceStrategy OPT_IN

This strategy adopts a conservative, opt-in approach that only considers a property to be non-transient if it is explicitly annotated with one of the following annotations:

1. Column
2. Computed
3. ClusteringColumn
4. Frozen
5. FrozenKey
6. FrozenValue
7. PartitionKey
8. Field

Method Detail

values

public static PropertyTransienceStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PropertyTransienceStrategy c : PropertyTransienceStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PropertyTransienceStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null