com.datastax.driver.mapping

Class Mapper.Option

java.lang.Object

com.datastax.driver.mapping.Mapper.Option

Enclosing class:

Mapper<T>

public abstract static class Mapper.Option
extends Object

An option for a mapper operation.

Options can be passed to individual operations:

     mapper.save(myObject, Option.ttl(3600));
 

The mapper can also have defaults, that will apply to all operations that do not override these particular option:

     mapper.setDefaultSaveOptions(Option.ttl(3600));
     mapper.save(myObject);
 

See the static methods in this class for available options.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Option(com.datastax.driver.mapping.Mapper.Option.Type type)

Method Summary

Modifier and Type	Method and Description
static Mapper.Option	consistencyLevel(ConsistencyLevel cl) Creates a new Option object to add a consistency level value to a mapper operation.
com.datastax.driver.mapping.Mapper.Option.Type	getType() Deprecated. This method is public for backward compatibility only. It should not be accessible since it leaks a package-private type.
static Mapper.Option	ifNotExists(boolean enabled) Creates a new Option object to specify whether an IF NOT EXISTS clause should be included in insert queries.
static Mapper.Option	saveNullFields(boolean enabled) Creates a new Option object to specify whether null entity fields should be included in insert queries.
static Mapper.Option	timestamp(long timestamp) Creates a new Option object to add a timestamp to a mapper operation.
static Mapper.Option	tracing(boolean enabled) Creates a new Option object to enable query tracing for a mapper operation.
static Mapper.Option	ttl(int ttl) Creates a new Option object to add time-to-live to a mapper operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Option

protected Option(com.datastax.driver.mapping.Mapper.Option.Type type)

Method Detail

ttl

public static Mapper.Option ttl(int ttl)

Creates a new Option object to add time-to-live to a mapper operation. This is only valid for save operations.

Note that this option is only available if using ProtocolVersion.V2 or above.

Parameters:

ttl - the TTL (in seconds).

Returns:

the option.

timestamp

public static Mapper.Option timestamp(long timestamp)

Creates a new Option object to add a timestamp to a mapper operation. This is only valid for save and delete operations.

Note that this option is only available if using ProtocolVersion.V2 or above.

Parameters:

timestamp - the timestamp (in microseconds).

Returns:

the option.

consistencyLevel

public static Mapper.Option consistencyLevel(ConsistencyLevel cl)

Creates a new Option object to add a consistency level value to a mapper operation. This is valid for save, delete and get operations.

Note that the consistency level can also be defined at the mapper level, as a parameter of the Table annotation (this is redundant for backward compatibility). This option, whether defined on a specific call or as the default, will always take precedence over the annotation.

Parameters:

cl - the ConsistencyLevel to use for the operation.

Returns:

the option.

tracing

public static Mapper.Option tracing(boolean enabled)

Creates a new Option object to enable query tracing for a mapper operation. This is valid for save, delete and get operations.

Parameters:

enabled - whether to enable tracing.

Returns:

the option.

saveNullFields

public static Mapper.Option saveNullFields(boolean enabled)

Creates a new Option object to specify whether null entity fields should be included in insert queries. This option is valid only for save operations.

If this option is not specified, it defaults to true (null fields are saved).

Parameters:

enabled - whether to include null fields in queries.

Returns:

the option.

ifNotExists

public static Mapper.Option ifNotExists(boolean enabled)

Creates a new Option object to specify whether an IF NOT EXISTS clause should be included in insert queries. This option is valid only for save operations.

If this option is not specified, it defaults to false (IF NOT EXISTS statements are not used).

Parameters:

enabled - whether to include an IF NOT EXISTS clause in queries.

Returns:

the option.

getType

@Deprecated
public com.datastax.driver.mapping.Mapper.Option.Type getType()

Deprecated. This method is public for backward compatibility only. It should not be accessible since it leaks a package-private type.