@Beta @Immutable public final class N extends PathOperand
Use ExpressionSpecBuilder.N(String)
to instantiate this class.
Modifier and Type | Method and Description |
---|---|
AddAction |
add(Number value)
Returns an
AddAction for build expression that would add the
given value mathematically to the existing attribute; or if the attribute
does not already exist, add the new attribute and the value to the item. |
BetweenCondition |
between(Number low,
Number high)
Returns a
BetweenCondition that represents a BETWEEN comparison (that evaluates to true if the value of the
current attribute is greater than or equal to the given low value, and
less than or equal to the given high value) for building condition
expression. |
ComparatorCondition |
eq(N 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(Number 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.
|
ComparatorCondition |
ge(N that)
Returns a comparator condition (that evaluates to true if the value of the current
attribute is greater than or equal to that of the specified attribute) for building
condition expression.
|
ComparatorCondition |
ge(Number value)
Returns a comparator condition (that evaluates to true if the value of the current
attribute is greater than or equal to the specified value) for building
condition expression.
|
ComparatorCondition |
gt(N that)
Returns a comparator condition (that evaluates to true if the value of the current
attribute is greater than that of the specified attribute) for building
condition expression.
|
ComparatorCondition |
gt(Number value)
Returns a comparator condition (that evaluates to true if the value of the current
attribute is greater than the specified value) for building
condition expression.
|
IfNotExistsFunction<N> |
ifNotExists(N 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<N> |
ifNotExists(Number 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. |
<T extends Number> |
in(List<T> 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(Number... 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 |
le(N that)
Returns a comparator condition (that evaluates to true if the value of the current
attribute is less than or equal to that of the specified attribute) for building
condition expression.
|
ComparatorCondition |
le(Number value)
Returns a comparator condition (that evaluates to true if the value of the current
attribute is less than or equal to the specified value) for building
condition expression.
|
ComparatorCondition |
lt(N that)
Returns a comparator condition (that evaluates to true if the value of the current
attribute is less than that of the specified attribute) for building
condition expression.
|
ComparatorCondition |
lt(Number value)
Returns a comparator condition (that evaluates to true if the value of the current
attribute is less than the specified value) for building
condition expression.
|
MinusOperation |
minus(N attr)
Returns a
MinusOperation object that represents the subtraction of
the value of the given attribute from that of the current attribute; used
for building update expression. |
MinusOperation |
minus(Number value)
Returns a
MinusOperation object that represents the subtraction of
the given value from that of the current attribute; used for building
update expression. |
ComparatorCondition |
ne(N 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(Number 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.
|
PlusOperation |
plus(N attr)
Returns a
PlusOperation object that represents the addition of the
value of the given attribute to that of the current attribute; used for
building update expression. |
PlusOperation |
plus(Number value)
Returns a
PlusOperation that represents the addition of the
given value to that of the current attribute; used for building update
expression. |
SetAction |
set(IfNotExistsFunction<N> ifNotExistsFunction)
Returns a
SetAction object used for building update
expression. |
SetAction |
set(MinusOperation minusOperation)
Returns a
SetAction object used for building update
expression with the specified MinusOperation . |
SetAction |
set(N source)
Returns a
SetAction object used for building update
expression. |
SetAction |
set(Number value)
Returns a
SetAction object used for building update
expression. |
SetAction |
set(PlusOperation plusOperation)
Returns a
SetAction object used for building update
expression with the specified PlusOperation . |
public ComparatorCondition eq(N that)
public ComparatorCondition ne(N that)
public ComparatorCondition le(Number value)
public ComparatorCondition le(N that)
public ComparatorCondition lt(Number value)
public ComparatorCondition lt(N that)
public ComparatorCondition ge(Number value)
public ComparatorCondition ge(N that)
public ComparatorCondition gt(Number value)
public ComparatorCondition gt(N that)
public BetweenCondition between(Number low, Number high)
BetweenCondition
that represents a BETWEEN comparison (that evaluates to true if the value of the
current attribute is greater than or equal to the given low value, and
less than or equal to the given high value) for building condition
expression.public AddAction add(Number value)
AddAction
for build expression that would add the
given value mathematically to the existing attribute; or if the attribute
does not already exist, add the new attribute and the value to the item.
In general, DynamoDB recommends using SET rather than ADD.
public PlusOperation plus(Number value)
PlusOperation
that represents the addition of the
given value to that of the current attribute; used for building update
expression.value
- given value to be added to the value of the current attribute.public PlusOperation plus(N attr)
PlusOperation
object that represents the addition of the
value of the given attribute to that of the current attribute; used for
building update expression.attr
- given attribute whose value is to be added to that of the
current attributepublic MinusOperation minus(Number value)
MinusOperation
object that represents the subtraction of
the given value from that of the current attribute; used for building
update expression.value
- given value to be subtracted from the value of the current
attribute.public MinusOperation minus(N attr)
MinusOperation
object that represents the subtraction of
the value of the given attribute from that of the current attribute; used
for building update expression.attr
- given attribute whose value is to be subtracted from that of
the current attributepublic final SetAction set(PlusOperation plusOperation)
SetAction
object used for building update
expression with the specified PlusOperation
. If the current
attribute doesn't exist, the returned object represents adding the result
of the specified plus ('+') binary operation as an attribute to an item.
If this attribute already exists, the returned object represents the
value replacement of the current attribute by the result of the specified
plus ('+') binary operation.public final SetAction set(MinusOperation minusOperation)
SetAction
object used for building update
expression with the specified MinusOperation
. If the current
attribute doesn't exist, the returned object represents adding the result
of the specified minus ('-') binary operation as an attribute to an item.
If this attribute already exists, the returned object represents the
value replacement of the current attribute by the result of the specified
minus ('-') binary operation.public final InCondition in(Number... values)
values
- specified values. The number of values must be at least one
and at most 100.public final <T extends Number> InCondition in(List<T> values)
values
- specified list of values. The number of values must be at
least one and at most 100.public SetAction set(N source)
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.public SetAction set(Number value)
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.public SetAction set(IfNotExistsFunction<N> ifNotExistsFunction)
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.public ComparatorCondition eq(Number value)
public ComparatorCondition ne(Number value)
public IfNotExistsFunction<N> ifNotExists(Number defaultValue)
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."
defaultValue
- the default value that will be used as the operand to the
if_not_exists function call.public IfNotExistsFunction<N> ifNotExists(N defaultValue)
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."
defaultValue
- the default value that will be used as the operand to the
if_not_exists function call.