software.amazon.awssdk.extensions.dynamodb.mappingclient

Class AttributeValues

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.AttributeValues

public final class AttributeValues
extends Object

This static helper class contains some literal AttributeValue constants and converters. Primarily these will be used if constructing a literal key object or for use in a custom filter expression. Eg: Key<?> myKey = Key.of(stringValue("id123"), numberValue(4.23)); Expression filterExpression = Expression.of("id = :filter_id", singletonMap(":filter_id", stringValue("id123"));

Method Summary

Modifier and Type	Method and Description
static AttributeValue	binaryValue(ByteBuffer value) Creates a literal binary AttributeValue from a Java ByteBuffer.
static boolean	isNullAttributeValue(AttributeValue attributeValue) A helper method to test if an AttributeValue is a 'null' constant.
static AttributeValue	nullAttributeValue() The constant that represents a 'null' in a DynamoDb record.
static AttributeValue	numberValue(Number value) Creates a literal numeric AttributeValue from any type of Java number.
static AttributeValue	stringValue(String value) Creates a literal string AttributeValue.

Methods inherited from class java.lang.Object

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

Method Detail

nullAttributeValue

public static AttributeValue nullAttributeValue()

The constant that represents a 'null' in a DynamoDb record.

Returns:

An AttributeValue of type NUL that represents 'null'.

stringValue

public static AttributeValue stringValue(String value)

Creates a literal string AttributeValue.

Parameters:

value - A string to create the literal from.

Returns:

An AttributeValue of type S that represents the string literal.

numberValue

public static AttributeValue numberValue(Number value)

Creates a literal numeric AttributeValue from any type of Java number.

Parameters:

value - A number to create the literal from.

Returns:

An AttributeValue of type n that represents the numeric literal.

binaryValue

public static AttributeValue binaryValue(ByteBuffer value)

Creates a literal binary AttributeValue from a Java ByteBuffer.

Parameters:

value - A ByteBuffer to create the literal from.

Returns:

An AttributeValue of type B that represents the binary literal.

isNullAttributeValue

public static boolean isNullAttributeValue(AttributeValue attributeValue)

A helper method to test if an AttributeValue is a 'null' constant. This will not test if the AttributeValue object is null itself, and in fact will throw a NullPointerException if you pass in null.

Parameters:

attributeValue - An AttributeValue to test for null.

Returns:

true if the supplied AttributeValue represents a null value, or false if it does not.