com.amazonaws.services.simpledb.model.UpdateCondition.java Source code

Java tutorial

Introduction

Here is the source code for com.amazonaws.services.simpledb.model.UpdateCondition.java

Source

/*
 * Copyright 2014-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.simpledb.model;

import java.io.Serializable;
import javax.annotation.Generated;

/**
 * <p>
 * Specifies the conditions under which data should be updated. If an update condition is specified for a request, the
 * data will only be updated if the condition is satisfied. For example, if an attribute with a specific name and value
 * exists, or if a specific attribute doesn't exist.
 * </p>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateCondition implements Serializable, Cloneable {

    /**
     * <p>
     * The name of the attribute involved in the condition.
     * </p>
     */
    private String name;
    /**
     * <p>
     * The value of an attribute. This value can only be specified when the <code>Exists</code> parameter is equal to
     * <code>true</code>.
     * </p>
     */
    private String value;
    /**
     * <p>
     * A value specifying whether or not the specified attribute must exist with the specified value in order for the
     * update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the update condition
     * to be satisfied. Specify <code>false</code> if the attribute should not exist in order for the update condition
     * to be satisfied.
     * </p>
     */
    private Boolean exists;

    /**
     * Default constructor for UpdateCondition object. Callers should use the setter or fluent setter (with...) methods
     * to initialize the object after creating it.
     */
    public UpdateCondition() {
    }

    /**
     * Constructs a new UpdateCondition object. Callers should use the setter or fluent setter (with...) methods to
     * initialize any additional object members.
     * 
     * @param name
     *        The name of the attribute involved in the condition.
     * @param value
     *        The value of an attribute. This value can only be specified when the <code>Exists</code> parameter is
     *        equal to <code>true</code>.
     * @param exists
     *        A value specifying whether or not the specified attribute must exist with the specified value in order for
     *        the update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the update
     *        condition to be satisfied. Specify <code>false</code> if the attribute should not exist in order for the
     *        update condition to be satisfied.
     */
    public UpdateCondition(String name, String value, Boolean exists) {
        setName(name);
        setValue(value);
        setExists(exists);
    }

    /**
     * <p>
     * The name of the attribute involved in the condition.
     * </p>
     * 
     * @param name
     *        The name of the attribute involved in the condition.
     */

    public void setName(String name) {
        this.name = name;
    }

    /**
     * <p>
     * The name of the attribute involved in the condition.
     * </p>
     * 
     * @return The name of the attribute involved in the condition.
     */

    public String getName() {
        return this.name;
    }

    /**
     * <p>
     * The name of the attribute involved in the condition.
     * </p>
     * 
     * @param name
     *        The name of the attribute involved in the condition.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public UpdateCondition withName(String name) {
        setName(name);
        return this;
    }

    /**
     * <p>
     * The value of an attribute. This value can only be specified when the <code>Exists</code> parameter is equal to
     * <code>true</code>.
     * </p>
     * 
     * @param value
     *        The value of an attribute. This value can only be specified when the <code>Exists</code> parameter is
     *        equal to <code>true</code>.
     */

    public void setValue(String value) {
        this.value = value;
    }

    /**
     * <p>
     * The value of an attribute. This value can only be specified when the <code>Exists</code> parameter is equal to
     * <code>true</code>.
     * </p>
     * 
     * @return The value of an attribute. This value can only be specified when the <code>Exists</code> parameter is
     *         equal to <code>true</code>.
     */

    public String getValue() {
        return this.value;
    }

    /**
     * <p>
     * The value of an attribute. This value can only be specified when the <code>Exists</code> parameter is equal to
     * <code>true</code>.
     * </p>
     * 
     * @param value
     *        The value of an attribute. This value can only be specified when the <code>Exists</code> parameter is
     *        equal to <code>true</code>.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public UpdateCondition withValue(String value) {
        setValue(value);
        return this;
    }

    /**
     * <p>
     * A value specifying whether or not the specified attribute must exist with the specified value in order for the
     * update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the update condition
     * to be satisfied. Specify <code>false</code> if the attribute should not exist in order for the update condition
     * to be satisfied.
     * </p>
     * 
     * @param exists
     *        A value specifying whether or not the specified attribute must exist with the specified value in order for
     *        the update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the update
     *        condition to be satisfied. Specify <code>false</code> if the attribute should not exist in order for the
     *        update condition to be satisfied.
     */

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

    /**
     * <p>
     * A value specifying whether or not the specified attribute must exist with the specified value in order for the
     * update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the update condition
     * to be satisfied. Specify <code>false</code> if the attribute should not exist in order for the update condition
     * to be satisfied.
     * </p>
     * 
     * @return A value specifying whether or not the specified attribute must exist with the specified value in order
     *         for the update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the
     *         update condition to be satisfied. Specify <code>false</code> if the attribute should not exist in order
     *         for the update condition to be satisfied.
     */

    public Boolean getExists() {
        return this.exists;
    }

    /**
     * <p>
     * A value specifying whether or not the specified attribute must exist with the specified value in order for the
     * update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the update condition
     * to be satisfied. Specify <code>false</code> if the attribute should not exist in order for the update condition
     * to be satisfied.
     * </p>
     * 
     * @param exists
     *        A value specifying whether or not the specified attribute must exist with the specified value in order for
     *        the update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the update
     *        condition to be satisfied. Specify <code>false</code> if the attribute should not exist in order for the
     *        update condition to be satisfied.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public UpdateCondition withExists(Boolean exists) {
        setExists(exists);
        return this;
    }

    /**
     * <p>
     * A value specifying whether or not the specified attribute must exist with the specified value in order for the
     * update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the update condition
     * to be satisfied. Specify <code>false</code> if the attribute should not exist in order for the update condition
     * to be satisfied.
     * </p>
     * 
     * @return A value specifying whether or not the specified attribute must exist with the specified value in order
     *         for the update condition to be satisfied. Specify <code>true</code> if the attribute must exist for the
     *         update condition to be satisfied. Specify <code>false</code> if the attribute should not exist in order
     *         for the update condition to be satisfied.
     */

    public Boolean isExists() {
        return this.exists;
    }

    /**
     * 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 (getName() != null)
            sb.append("Name: ").append(getName()).append(",");
        if (getValue() != null)
            sb.append("Value: ").append(getValue()).append(",");
        if (getExists() != null)
            sb.append("Exists: ").append(getExists());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof UpdateCondition == false)
            return false;
        UpdateCondition other = (UpdateCondition) obj;
        if (other.getName() == null ^ this.getName() == null)
            return false;
        if (other.getName() != null && other.getName().equals(this.getName()) == false)
            return false;
        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;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
        hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
        hashCode = prime * hashCode + ((getExists() == null) ? 0 : getExists().hashCode());
        return hashCode;
    }

    @Override
    public UpdateCondition clone() {
        try {
            return (UpdateCondition) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

}