/* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.dynamodbv2.model; import java.io.Serializable; /** *

* Represents a condition to be compared with an attribute value. This condition * can be used with DeleteItem, PutItem or * UpdateItem operations; if the comparison evaluates to true, the * operation succeeds; if not, the operation fails. You can use * ExpectedAttributeValue in one of two different ways: *

* *

* Value and Exists are incompatible with * AttributeValueList and ComparisonOperator. Note * that if you use both sets of parameters at once, DynamoDB will return a * ValidationException exception. *

*/ public class ExpectedAttributeValue implements Serializable { /** *

* Represents the data for the expected attribute. *

*

* Each attribute value is described as a name-value pair. The name is the * data type, and the value is the data itself. *

*

* For more information, see Data Types in the Amazon DynamoDB Developer Guide. *

*/ private AttributeValue value; /** *

* Causes DynamoDB to evaluate the value before attempting a conditional * operation: *

* *

* The default setting for Exists is true. If you * supply a Value all by itself, DynamoDB assumes the attribute * exists: You don't have to set Exists to true, * because it is implied. *

*

* DynamoDB returns a ValidationException if: *

* */ private Boolean exists; /** *

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater than, less * than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* *

* Constraints:
* Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH */ private String comparisonOperator; /** *

* One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the ComparisonOperator * being used. *

*

* For type Number, value comparisons are numeric. *

*

* String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, a is greater * than A, and a is greater than B. * For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

*

* For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. *

*

* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide. *

*/ private java.util.List attributeValueList; /** * Default constructor for ExpectedAttributeValue object. Callers should use * the setter or fluent setter (with...) methods to initialize any * additional object members. */ public ExpectedAttributeValue() { } /** * Constructs a new ExpectedAttributeValue object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. * * @param value

* Represents the data for the expected attribute. *

*

* Each attribute value is described as a name-value pair. The * name is the data type, and the value is the data itself. *

*

* For more information, see Data Types in the Amazon DynamoDB Developer Guide. *

*/ public ExpectedAttributeValue(AttributeValue value) { setValue(value); } /** * Constructs a new ExpectedAttributeValue object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. * * @param exists

* Causes DynamoDB to evaluate the value before attempting a * conditional operation: *

* *

* The default setting for Exists is * true. If you supply a Value all by * itself, DynamoDB assumes the attribute exists: You don't have * to set Exists to true, because it is * implied. *

*

* DynamoDB returns a ValidationException if: *

* */ public ExpectedAttributeValue(Boolean exists) { setExists(exists); } /** *

* Represents the data for the expected attribute. *

*

* Each attribute value is described as a name-value pair. The name is the * data type, and the value is the data itself. *

*

* For more information, see Data Types in the Amazon DynamoDB Developer Guide. *

* * @return

* Represents the data for the expected attribute. *

*

* Each attribute value is described as a name-value pair. The name * is the data type, and the value is the data itself. *

*

* For more information, see Data Types in the Amazon DynamoDB Developer Guide. *

*/ public AttributeValue getValue() { return value; } /** *

* Represents the data for the expected attribute. *

*

* Each attribute value is described as a name-value pair. The name is the * data type, and the value is the data itself. *

*

* For more information, see Data Types in the Amazon DynamoDB Developer Guide. *

* * @param value

* Represents the data for the expected attribute. *

*

* Each attribute value is described as a name-value pair. The * name is the data type, and the value is the data itself. *

*

* For more information, see Data Types in the Amazon DynamoDB Developer Guide. *

*/ public void setValue(AttributeValue value) { this.value = value; } /** *

* Represents the data for the expected attribute. *

*

* Each attribute value is described as a name-value pair. The name is the * data type, and the value is the data itself. *

*

* For more information, see Data Types in the Amazon DynamoDB Developer Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param value

* Represents the data for the expected attribute. *

*

* Each attribute value is described as a name-value pair. The * name is the data type, and the value is the data itself. *

*

* For more information, see Data Types in the Amazon DynamoDB Developer Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ExpectedAttributeValue withValue(AttributeValue value) { this.value = value; return this; } /** *

* Causes DynamoDB to evaluate the value before attempting a conditional * operation: *

* *

* The default setting for Exists is true. If you * supply a Value all by itself, DynamoDB assumes the attribute * exists: You don't have to set Exists to true, * because it is implied. *

*

* DynamoDB returns a ValidationException if: *

* * * @return

* Causes DynamoDB to evaluate the value before attempting a * conditional operation: *

* *

* The default setting for Exists is true. * If you supply a Value all by itself, DynamoDB * assumes the attribute exists: You don't have to set * Exists to true, because it is implied. *

*

* DynamoDB returns a ValidationException if: *

* */ public Boolean isExists() { return exists; } /** *

* Causes DynamoDB to evaluate the value before attempting a conditional * operation: *

* *

* The default setting for Exists is true. If you * supply a Value all by itself, DynamoDB assumes the attribute * exists: You don't have to set Exists to true, * because it is implied. *

*

* DynamoDB returns a ValidationException if: *

* * * @return

* Causes DynamoDB to evaluate the value before attempting a * conditional operation: *

* *

* The default setting for Exists is true. * If you supply a Value all by itself, DynamoDB * assumes the attribute exists: You don't have to set * Exists to true, because it is implied. *

*

* DynamoDB returns a ValidationException if: *

* */ public Boolean getExists() { return exists; } /** *

* Causes DynamoDB to evaluate the value before attempting a conditional * operation: *

* *

* The default setting for Exists is true. If you * supply a Value all by itself, DynamoDB assumes the attribute * exists: You don't have to set Exists to true, * because it is implied. *

*

* DynamoDB returns a ValidationException if: *

* * * @param exists

* Causes DynamoDB to evaluate the value before attempting a * conditional operation: *

* *

* The default setting for Exists is * true. If you supply a Value all by * itself, DynamoDB assumes the attribute exists: You don't have * to set Exists to true, because it is * implied. *

*

* DynamoDB returns a ValidationException if: *

* */ public void setExists(Boolean exists) { this.exists = exists; } /** *

* Causes DynamoDB to evaluate the value before attempting a conditional * operation: *

* *

* The default setting for Exists is true. If you * supply a Value all by itself, DynamoDB assumes the attribute * exists: You don't have to set Exists to true, * because it is implied. *

*

* DynamoDB returns a ValidationException if: *

* *

* Returns a reference to this object so that method calls can be chained * together. * * @param exists

* Causes DynamoDB to evaluate the value before attempting a * conditional operation: *

* *

* The default setting for Exists is * true. If you supply a Value all by * itself, DynamoDB assumes the attribute exists: You don't have * to set Exists to true, because it is * implied. *

*

* DynamoDB returns a ValidationException if: *

* * @return A reference to this updated object so that method calls can be * chained together. */ public ExpectedAttributeValue withExists(Boolean exists) { this.exists = exists; return this; } /** *

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater than, less * than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* *

* Constraints:
* Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @return

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater * than, less than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* * @see ComparisonOperator */ public String getComparisonOperator() { return comparisonOperator; } /** *

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater than, less * than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* *

* Constraints:
* Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @param comparisonOperator

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater * than, less than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* * @see ComparisonOperator */ public void setComparisonOperator(String comparisonOperator) { this.comparisonOperator = comparisonOperator; } /** *

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater than, less * than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @param comparisonOperator

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater * than, less than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* * @return A reference to this updated object so that method calls can be * chained together. * @see ComparisonOperator */ public ExpectedAttributeValue withComparisonOperator(String comparisonOperator) { this.comparisonOperator = comparisonOperator; return this; } /** *

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater than, less * than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* *

* Constraints:
* Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @param comparisonOperator

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater * than, less than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* * @see ComparisonOperator */ public void setComparisonOperator(ComparisonOperator comparisonOperator) { this.comparisonOperator = comparisonOperator.toString(); } /** *

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater than, less * than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, * NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH * * @param comparisonOperator

* A comparator for evaluating attributes in the * AttributeValueList. For example, equals, greater * than, less than, etc. *

*

* The following comparison operators are available: *

*

* EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN *

*

* The following are descriptions of each comparison operator. *

* * @return A reference to this updated object so that method calls can be * chained together. * @see ComparisonOperator */ public ExpectedAttributeValue withComparisonOperator(ComparisonOperator comparisonOperator) { this.comparisonOperator = comparisonOperator.toString(); return this; } /** *

* One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the ComparisonOperator * being used. *

*

* For type Number, value comparisons are numeric. *

*

* String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, a is greater * than A, and a is greater than B. * For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

*

* For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. *

*

* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide. *

* * @return

* One or more values to evaluate against the supplied attribute. * The number of values in the list depends on the * ComparisonOperator being used. *

*

* For type Number, value comparisons are numeric. *

*

* String value comparisons for greater than, equals, or less than * are based on ASCII character code values. For example, * a is greater than A, and a * is greater than B. For a list of code values, see http * ://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

*

* For Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values. *

*

* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer * Guide. *

*/ public java.util.List getAttributeValueList() { return attributeValueList; } /** *

* One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the ComparisonOperator * being used. *

*

* For type Number, value comparisons are numeric. *

*

* String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, a is greater * than A, and a is greater than B. * For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

*

* For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. *

*

* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide. *

* * @param attributeValueList

* One or more values to evaluate against the supplied attribute. * The number of values in the list depends on the * ComparisonOperator being used. *

*

* For type Number, value comparisons are numeric. *

*

* String value comparisons for greater than, equals, or less * than are based on ASCII character code values. For example, * a is greater than A, and * a is greater than B. For a list of * code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters * . *

*

* For Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values. *

*

* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer * Guide. *

*/ public void setAttributeValueList(java.util.Collection attributeValueList) { if (attributeValueList == null) { this.attributeValueList = null; return; } this.attributeValueList = new java.util.ArrayList(attributeValueList); } /** *

* One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the ComparisonOperator * being used. *

*

* For type Number, value comparisons are numeric. *

*

* String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, a is greater * than A, and a is greater than B. * For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

*

* For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. *

*

* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param attributeValueList

* One or more values to evaluate against the supplied attribute. * The number of values in the list depends on the * ComparisonOperator being used. *

*

* For type Number, value comparisons are numeric. *

*

* String value comparisons for greater than, equals, or less * than are based on ASCII character code values. For example, * a is greater than A, and * a is greater than B. For a list of * code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters * . *

*

* For Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values. *

*

* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer * Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ExpectedAttributeValue withAttributeValueList(AttributeValue... attributeValueList) { if (getAttributeValueList() == null) { this.attributeValueList = new java.util.ArrayList( attributeValueList.length); } for (AttributeValue value : attributeValueList) { this.attributeValueList.add(value); } return this; } /** *

* One or more values to evaluate against the supplied attribute. The number * of values in the list depends on the ComparisonOperator * being used. *

*

* For type Number, value comparisons are numeric. *

*

* String value comparisons for greater than, equals, or less than are based * on ASCII character code values. For example, a is greater * than A, and a is greater than B. * For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. *

*

* For Binary, DynamoDB treats each byte of the binary data as unsigned when * it compares binary values. *

*

* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param attributeValueList

* One or more values to evaluate against the supplied attribute. * The number of values in the list depends on the * ComparisonOperator being used. *

*

* For type Number, value comparisons are numeric. *

*

* String value comparisons for greater than, equals, or less * than are based on ASCII character code values. For example, * a is greater than A, and * a is greater than B. For a list of * code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters * . *

*

* For Binary, DynamoDB treats each byte of the binary data as * unsigned when it compares binary values. *

*

* For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer * Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ExpectedAttributeValue withAttributeValueList( java.util.Collection attributeValueList) { setAttributeValueList(attributeValueList); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getValue() != null) sb.append("Value: " + getValue() + ","); if (getExists() != null) sb.append("Exists: " + getExists() + ","); if (getComparisonOperator() != null) sb.append("ComparisonOperator: " + getComparisonOperator() + ","); if (getAttributeValueList() != null) sb.append("AttributeValueList: " + getAttributeValueList()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode()); hashCode = prime * hashCode + ((getExists() == null) ? 0 : getExists().hashCode()); hashCode = prime * hashCode + ((getComparisonOperator() == null) ? 0 : getComparisonOperator().hashCode()); hashCode = prime * hashCode + ((getAttributeValueList() == null) ? 0 : getAttributeValueList().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ExpectedAttributeValue == false) return false; ExpectedAttributeValue other = (ExpectedAttributeValue) obj; if (other.getValue() == null ^ this.getValue() == null) return false; if (other.getValue() != null && other.getValue().equals(this.getValue()) == false) return false; if (other.getExists() == null ^ this.getExists() == null) return false; if (other.getExists() != null && other.getExists().equals(this.getExists()) == false) return false; if (other.getComparisonOperator() == null ^ this.getComparisonOperator() == null) return false; if (other.getComparisonOperator() != null && other.getComparisonOperator().equals(this.getComparisonOperator()) == false) return false; if (other.getAttributeValueList() == null ^ this.getAttributeValueList() == null) return false; if (other.getAttributeValueList() != null && other.getAttributeValueList().equals(this.getAttributeValueList()) == false) return false; return true; } }