/* * Copyright 2018-2023 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; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* Represents the selection criteria for a Query or Scan operation: *

* * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Condition implements Serializable, Cloneable, StructuredPojo { /** *

* 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. *

*/ private java.util.List attributeValueList; /** *

* A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer Guide. *

*/ 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. *

* * @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. */ 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. *

* * @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. */ 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. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setAttributeValueList(java.util.Collection)} or {@link #withAttributeValueList(java.util.Collection)} if * you want to override the existing values. *

* * @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. * @return Returns a reference to this object so that method calls can be chained together. */ public Condition withAttributeValueList(AttributeValue... attributeValueList) { if (this.attributeValueList == null) { setAttributeValueList(new java.util.ArrayList(attributeValueList.length)); } for (AttributeValue ele : attributeValueList) { this.attributeValueList.add(ele); } 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. *

* * @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. * @return Returns a reference to this object so that method calls can be chained together. */ public Condition withAttributeValueList(java.util.Collection attributeValueList) { setAttributeValueList(attributeValueList); return this; } /** *

* A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer Guide. *

* * @param comparisonOperator * A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide. * @see ComparisonOperator */ public void setComparisonOperator(String comparisonOperator) { this.comparisonOperator = comparisonOperator; } /** *

* A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer Guide. *

* * @return A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide. * @see ComparisonOperator */ public String getComparisonOperator() { return this.comparisonOperator; } /** *

* A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer Guide. *

* * @param comparisonOperator * A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. * @see ComparisonOperator */ public Condition withComparisonOperator(String comparisonOperator) { setComparisonOperator(comparisonOperator); return this; } /** *

* A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer Guide. *

* * @param comparisonOperator * A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide. * @see ComparisonOperator */ public void setComparisonOperator(ComparisonOperator comparisonOperator) { withComparisonOperator(comparisonOperator); } /** *

* A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy * Conditional Parameters in the Amazon DynamoDB Developer Guide. *

* * @param comparisonOperator * A comparator for evaluating attributes. 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. *

* *

* For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. * @see ComparisonOperator */ public Condition withComparisonOperator(ComparisonOperator comparisonOperator) { this.comparisonOperator = comparisonOperator.toString(); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getAttributeValueList() != null) sb.append("AttributeValueList: ").append(getAttributeValueList()).append(","); if (getComparisonOperator() != null) sb.append("ComparisonOperator: ").append(getComparisonOperator()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof Condition == false) return false; Condition other = (Condition) obj; if (other.getAttributeValueList() == null ^ this.getAttributeValueList() == null) return false; if (other.getAttributeValueList() != null && other.getAttributeValueList().equals(this.getAttributeValueList()) == false) return false; if (other.getComparisonOperator() == null ^ this.getComparisonOperator() == null) return false; if (other.getComparisonOperator() != null && other.getComparisonOperator().equals(this.getComparisonOperator()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAttributeValueList() == null) ? 0 : getAttributeValueList().hashCode()); hashCode = prime * hashCode + ((getComparisonOperator() == null) ? 0 : getComparisonOperator().hashCode()); return hashCode; } @Override public Condition clone() { try { return (Condition) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.dynamodbv2.model.transform.ConditionMarshaller.getInstance().marshall(this, protocolMarshaller); } }