Package software.amazon.awssdk.services.dynamodb.datamodeling

Class DynamoDbMapperFieldModel<T,V>

java.lang.Object

software.amazon.awssdk.services.dynamodb.datamodeling.DynamoDbMapperFieldModel<T,V>

Type Parameters:

T - The object type.

V - The field model type.

All Implemented Interfaces:

DynamoDbAutoGenerator<V>, DynamoDbTypeConverter<AttributeValue,V>

public class DynamoDbMapperFieldModel<T,V>
extends Object
implements DynamoDbAutoGenerator<V>, DynamoDbTypeConverter<AttributeValue,V>

Field model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DynamoDbMapperFieldModel.DynamoDbAttributeType

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.dynamodb.datamodeling.DynamoDbAutoGenerator

DynamoDbAutoGenerator.AbstractGenerator<T>

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.dynamodb.datamodeling.DynamoDbTypeConverter

DynamoDbTypeConverter.AbstractConverter<S,T>, DynamoDbTypeConverter.DelegateConverter<S,T>, DynamoDbTypeConverter.ExtendedConverter<S,U,T>, DynamoDbTypeConverter.NullSafeConverter<S,T>

Method Summary

Modifier and Type	Method	Description
DynamoDbMapperFieldModel.DynamoDbAttributeType	attributeType()	Gets the DynamoDB attribute type.
Condition	beginsWith(V value)	Creates a condition which filters on the specified value.
Condition	between(V lo, V hi)	Creates a condition which filters on the specified values.
Condition	betweenAny(V lo, V hi)	Creates a condition which filters on any non-null argument; if lo is null a LE condition is applied on hi, if hi is null a GE condition is applied on lo.
Condition	contains(V value)	Creates a condition which filters on the specified value.
AttributeValue	convert(V object)	Turns an object of type T into an object of type S.
Condition	eq(V value)	Creates a condition which filters on the specified value.
Condition	ge(V value)	Creates a condition which filters on the specified value.
V	generate(V currentValue)	Generates a new value given the current value (or null) if applicable.
V	get(T object)	Gets the value from the object instance.
AttributeValue	getAndConvert(T object)	Get the current value from the object and convert it.
String	getDynamoDbAttributeName()	Deprecated. replaced by name()
DynamoDbMapperFieldModel.DynamoDbAttributeType	getDynamoDbAttributeType()	Deprecated. replaced by attributeType
DynamoDbAutoGenerateStrategy	getGenerateStrategy()	Gets the auto-generate strategy.
List<String>	globalSecondaryIndexNames(KeyType keyType)	Gets the global secondary indexes.
Condition	gt(V value)	Creates a condition which filters on the specified value.
Condition	in(Collection<V> values)	Creates a condition which filters on the specified values.
Condition	in(V... values)	Creates a condition which filters on the specified values.
boolean	indexed()	Returns true if the field has any indexes.
Condition	isNull()	Creates a condition which filters on the specified value.
KeyType	keyType()	Gets the key type.
Condition	le(V value)	Creates a condition which filters on the specified value.
List<String>	localSecondaryIndexNames()	Gets the local secondary indexes.
Condition	lt(V value)	Creates a condition which filters on the specified value.
String	name()	Gets the attribute name.
Condition	ne(V value)	Creates a condition which filters on the specified value.
Condition	notContains(V value)	Creates a condition which filters on the specified value.
Condition	notNull()	Creates a condition which filters on the specified value.
void	set(T object, V value)	Sets the value on the object instance.
V	unconvert(AttributeValue object)	Turns an object of type S into an object of type T.
void	unconvertAndSet(T object, AttributeValue value)	Unconverts the value and sets it on the object.
boolean	versioned()	Indicates if this attribute is a version attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getDynamoDbAttributeName

@Deprecated
public String getDynamoDbAttributeName()

Deprecated. replaced by name()

getDynamoDbAttributeType

@Deprecated
public DynamoDbMapperFieldModel.DynamoDbAttributeType getDynamoDbAttributeType()

Deprecated. replaced by attributeType

name

public final String name()

Gets the attribute name.

Returns:

The attribute name.

get

public final V get(T object)

Gets the value from the object instance.

Parameters:

object - The object instance.

Returns:

The value.

set

public final void set(T object,
                      V value)

Sets the value on the object instance.

Parameters:

object - The object instance.

value - The value.

getGenerateStrategy

public final DynamoDbAutoGenerateStrategy getGenerateStrategy()

Gets the auto-generate strategy.

Specified by:

getGenerateStrategy in interface DynamoDbAutoGenerator<T>

generate

public final V generate(V currentValue)

Generates a new value given the current value (or null) if applicable.

Specified by:

generate in interface DynamoDbAutoGenerator<T>

convert

public final AttributeValue convert(V object)

Turns an object of type T into an object of type S.

Specified by:

convert in interface DynamoDbTypeConverter<T,V>

unconvert

public final V unconvert(AttributeValue object)

Turns an object of type S into an object of type T.

Specified by:

unconvert in interface DynamoDbTypeConverter<T,V>

getAndConvert

public final AttributeValue getAndConvert(T object)

Get the current value from the object and convert it.

Parameters:

object - The object instance.

Returns:

The converted value.

unconvertAndSet

public final void unconvertAndSet(T object,
                                  AttributeValue value)

Unconverts the value and sets it on the object.

Parameters:

object - The object instance.

value - The attribute value.

attributeType

public final DynamoDbMapperFieldModel.DynamoDbAttributeType attributeType()

Gets the DynamoDB attribute type.

Returns:

The DynamoDB attribute type.

keyType

public final KeyType keyType()

Gets the key type.

Returns:

The key type if a key field, null otherwise.

versioned

public final boolean versioned()

Indicates if this attribute is a version attribute.

Returns:

True if it is, false otherwise.

globalSecondaryIndexNames

public final List<String> globalSecondaryIndexNames(KeyType keyType)

Gets the global secondary indexes.

Parameters:

keyType - The key type.

Returns:

The list of global secondary indexes.

localSecondaryIndexNames

public final List<String> localSecondaryIndexNames()

Gets the local secondary indexes.

Returns:

The list of local secondary indexes.

indexed

public final boolean indexed()

Returns true if the field has any indexes.

Returns:

True if the propery matches.

beginsWith

public final Condition beginsWith(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.BEGINS_WITH, Condition

between

public final Condition between(V lo,
                               V hi)

Creates a condition which filters on the specified values.

Parameters:

lo - The start of the range (inclusive).

hi - The end of the range (inclusive).

Returns:

The condition.

See Also:

ComparisonOperator.BETWEEN, Condition

contains

public final Condition contains(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.CONTAINS, Condition

eq

public final Condition eq(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.EQ, Condition

ge

public final Condition ge(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.GE, Condition

gt

public final Condition gt(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.GT, Condition

in

public final Condition in(Collection<V> values)

Creates a condition which filters on the specified values.

Parameters:

values - The values.

Returns:

The condition.

See Also:

ComparisonOperator.IN, Condition

in

public final Condition in(V... values)

Creates a condition which filters on the specified values.

Parameters:

values - The values.

Returns:

The condition.

See Also:

ComparisonOperator.IN, Condition

isNull

public final Condition isNull()

Creates a condition which filters on the specified value.

Returns:

The condition.

See Also:

ComparisonOperator.NULL, Condition

le

public final Condition le(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.LE, Condition

lt

public final Condition lt(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.LT, Condition

ne

public final Condition ne(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.NE, Condition

notContains

public final Condition notContains(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.NOT_CONTAINS, Condition

notNull

public final Condition notNull()

Creates a condition which filters on the specified value.

Returns:

The condition.

See Also:

ComparisonOperator.NOT_NULL, Condition

betweenAny

public final Condition betweenAny(V lo,
                                  V hi)

Creates a condition which filters on any non-null argument; if lo is null a LE condition is applied on hi, if hi is null a GE condition is applied on lo.

Parameters:

lo - The start of the range (inclusive).

hi - The end of the range (inclusive).

Returns:

The condition or null if both arguments are null.

See Also:

ComparisonOperator.BETWEEN, ComparisonOperator.EQ, ComparisonOperator.GE, ComparisonOperator.LE, Condition