com.amazonaws.services.dynamodbv2.xspec

Class BOOL

java.lang.Object

com.amazonaws.services.dynamodbv2.xspec.Operand

com.amazonaws.services.dynamodbv2.xspec.PathOperand

com.amazonaws.services.dynamodbv2.xspec.BOOL

@Beta
@Immutable
public final class BOOL
extends PathOperand

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

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

Method Summary

Methods

Modifier and Type	Method and Description
ComparatorCondition	eq(BOOL 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(boolean value) Returns a comparator condition (that evaluates to true if the value of the current attribute is equal to that of the specified value) for building condition expression.
IfNotExistsFunction<BOOL>	ifNotExists(BOOL 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.
IfNotExistsFunction<BOOL>	ifNotExists(boolean 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(boolean... 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.
InCondition	in(List<Boolean> 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.
ComparatorCondition	ne(BOOL 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(boolean value) Returns a comparator condition (that evaluates to true if the value of the current attribute is not equal to that of the specified value) for building condition expression.
SetAction	set(BOOL source) Returns a SetAction object used for building update expression.
SetAction	set(boolean value) Returns a SetAction object used for building update expression.
SetAction	set(IfNotExistsFunction<BOOL> ifNotExistsFunction) 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

eq

public ComparatorCondition eq(boolean value)

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

eq

public ComparatorCondition eq(BOOL 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(boolean value)

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

ne

public ComparatorCondition ne(BOOL 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.

in

public final InCondition in(boolean... 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 InCondition in(List<Boolean> 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.

ifNotExists

public IfNotExistsFunction<BOOL> ifNotExists(boolean 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.

ifNotExists

public IfNotExistsFunction<BOOL> ifNotExists(BOOL 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 (of another boolean attribute) that will be used as the operand to the if_not_exists function call.

set

public SetAction set(BOOL 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(boolean 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<BOOL> 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.