com.amazonaws.services.dynamodbv2.xspec

Class S

java.lang.Object

com.amazonaws.services.dynamodbv2.xspec.Operand

com.amazonaws.services.dynamodbv2.xspec.PathOperand

com.amazonaws.services.dynamodbv2.xspec.S

@Beta
@Immutable
public final class S
extends PathOperand

A path operand that refers to a string attribute in DynamoDB; used for building expressions.

Use ExpressionSpecBuilder.S(String) to instantiate this class.

Method Summary

Methods

Modifier and Type	Method and Description
FunctionCondition	beginsWith(String value) Returns a function condition (that evaluates to true if the value of the current attribute begins with the specified operand) for building condition expression.
FunctionCondition	contains(String substring) Returns a function condition (that evaluates to true if the value of the current attribute contains the specified substring) for building condition expression.
ComparatorCondition	eq(S that) Returns a comparator condition (that evaluates to true if the value of the current attribute is equal to that of the specified attribute) for building condition expression.
ComparatorCondition	eq(String value) Returns a comparator condition (that evaluates to true if the attribute value referred to by this path operand is equal to the specified value) for building condition expression.
IfNotExistsFunction<S>	ifNotExists(S defaultValue) Returns an IfNotExists object which represents an if_not_exists(path, operand) function call where path refers to that of the current attribute; used for building expressions.
IfNotExistsFunction<S>	ifNotExists(String defaultValue) Returns an IfNotExists object which represents an if_not_exists(path, operand) function call where path refers to that of the current path operand; used for building expressions.
InCondition	in(List<String> values) Returns an InCondition (that evaluates to true if the value of the current attribute is equal to any of the values in the specified list) for building condition expression.
InCondition	in(String... values) Returns an InCondition (that evaluates to true if the value of the current attribute is equal to any of the specified values) for building condition expression.
ComparatorCondition	ne(S that) Returns a comparator condition (that evaluates to true if the value of the current attribute is not equal to that of the specified attribute) for building condition expression.
ComparatorCondition	ne(String value) Returns a comparator condition (that evaluates to true if the attribute value referred to by this path operand is not equal to that of the specified path operand) for building condition expression.
SetAction	set(IfNotExistsFunction<S> ifNotExistsFunction) Returns a SetAction object used for building update expression.
SetAction	set(S source) Returns a SetAction object used for building update expression.
SetAction	set(String value) Returns a SetAction object used for building update expression.

Methods inherited from class com.amazonaws.services.dynamodbv2.xspec.PathOperand

equals, exists, hashCode, notExists, remove, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

beginsWith

public FunctionCondition beginsWith(String value)

Returns a function condition (that evaluates to true if the value of the current attribute begins with the specified operand) for building condition expression.

contains

public FunctionCondition contains(String substring)

Returns a function condition (that evaluates to true if the value of the current attribute contains the specified substring) for building condition expression.

eq

public ComparatorCondition eq(S that)

Returns a comparator condition (that evaluates to true if the value of the current attribute is equal to that of the specified attribute) for building condition expression.

ne

public ComparatorCondition ne(S that)

Returns a comparator condition (that evaluates to true if the value of the current attribute is not equal to that of the specified attribute) for building condition expression.

ifNotExists

public IfNotExistsFunction<S> ifNotExists(S defaultValue)

Returns an IfNotExists object which represents an if_not_exists(path, operand) function call where path refers to that of the current attribute; used for building expressions.

 "if_not_exists (path, operand) ??? If the item does not contain an attribute
 at the specified path, then if_not_exists evaluates to operand; otherwise,
 it evaluates to path. You can use this function to avoid overwriting an
 attribute already present in the item."
 

Parameters:

defaultValue - the default value that will be used as the operand to the if_not_exists function call.

in

public final InCondition in(String... values)

Returns an InCondition (that evaluates to true if the value of the current attribute is equal to any of the specified values) for building condition expression.

Parameters:

values - specified values. The number of values must be at least one and at most 100.

in

public final InCondition in(List<String> values)

Returns an InCondition (that evaluates to true if the value of the current attribute is equal to any of the values in the specified list) for building condition expression.

Parameters:

values - specified list of values. The number of values must be at least one and at most 100.

set

public SetAction set(S source)

Returns a SetAction object used for building update expression. If the attribute referred to by this path operand doesn't exist, the returned object represents adding the attribute value of the specified source path operand to an item. If the current attribute already exists, the returned object represents the value replacement of the current attribute by the attribute value of the specified source path operand.

set

public SetAction set(String value)

Returns a SetAction object used for building update expression. If the attribute referred to by this path operand doesn't exist, the returned object represents adding the specified value as an attribute to an item. If the attribute referred to by this path operand already exists, the returned object represents the value replacement of the current attribute by the specified value.

set

public SetAction set(IfNotExistsFunction<S> ifNotExistsFunction)

Returns a SetAction object used for building update expression. If the attribute referred to by this path operand doesn't exist, the returned object represents adding the value of evaluating the specified IfNotExists function as an attribute to an item. If the attribute referred to by this path operand already exists, the returned object represents the value replacement of the current attribute by the value of evaluating the specified IfNotExists function.

eq

public ComparatorCondition eq(String value)

Returns a comparator condition (that evaluates to true if the attribute value referred to by this path operand is equal to the specified value) for building condition expression.

ne

public ComparatorCondition ne(String value)

Returns a comparator condition (that evaluates to true if the attribute value referred to by this path operand is not equal to that of the specified path operand) for building condition expression.

ifNotExists

public IfNotExistsFunction<S> ifNotExists(String defaultValue)

Returns an IfNotExists object which represents an if_not_exists(path, operand) function call where path refers to that of the current path operand; used for building expressions.

 "if_not_exists (path, operand) ??? If the item does not contain an attribute
 at the specified path, then if_not_exists evaluates to operand; otherwise,
 it evaluates to path. You can use this function to avoid overwriting an
 attribute already present in the item."
 

Parameters:

defaultValue - the default value that will be used as the operand to the if_not_exists function call.