com.amazonaws.services.dynamodbv2.xspec

Class PathOperand

java.lang.Object

com.amazonaws.services.dynamodbv2.xspec.Operand

com.amazonaws.services.dynamodbv2.xspec.PathOperand

Direct Known Subclasses:

B, BOOL, BS, L, M, N, NS, NULL, S, SS

@Beta
 @Immutable
public class PathOperand
extends Operand

A path operand used in building DynamooDB expressions such as update expressions and condition (aka filter) expressions. In general, a path operand refers to an attribute of some specific type in DynamoDB.

Use ExpressionSpecBuilder.S(String), ExpressionSpecBuilder.N(String), etc. to instantiate path operands to refer to attributes of specific data types. You can also use ExpressionSpecBuilder.attribute(String) to instantiate a path operand with an unspecified data type.

See Also:

ExpressionSpecBuilder

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if the given object is a path operand with the same path as that of the current path operand; false otherwise.
FunctionCondition	exists() Returns a function condition (that evaluates to true if the attribute referred to by this path operand exists) for building condition expression.
int	hashCode()
FunctionCondition	notExists() Returns a function condition (that evaluates to true if the attribute referred to by this path operand does not exist) for building condition expression.
RemoveAction	remove() Returns a RemoveAction for removing the attribute referred to by this path operand from an item; used for building update expression.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

exists

public final FunctionCondition exists()

Returns a function condition (that evaluates to true if the attribute referred to by this path operand exists) for building condition expression.

notExists

public final FunctionCondition notExists()

Returns a function condition (that evaluates to true if the attribute referred to by this path operand does not exist) for building condition expression.

remove

public final RemoveAction remove()

Returns a RemoveAction for removing the attribute referred to by this path operand from an item; used for building update expression.

toString

public final String toString()

Overrides:

toString in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object o)

Returns true if the given object is a path operand with the same path as that of the current path operand; false otherwise.

Overrides:

equals in class Object