software.amazon.awssdk.enhanced.dynamodb.extensions.WriteModification Maven / Gradle / Ivy

Go to download
/*
 * Copyright 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 software.amazon.awssdk.enhanced.dynamodb.extensions;

import java.util.Map;
import software.amazon.awssdk.annotations.NotThreadSafe;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.enhanced.dynamodb.Expression;
import software.amazon.awssdk.enhanced.dynamodb.update.UpdateExpression;
import software.amazon.awssdk.services.dynamodb.model.AttributeValue;

/**
 * Simple object for storing a modification to a write operation.
 * 
 * If a transformedItem is supplied then this item will be completely substituted in place of the item that was
 * previously going to be written.
 * 

 * If an additionalConditionalExpression is supplied then this condition will be coalesced with any other conditions
 * and added as a parameter to the write operation.
 * 
 * If an updateExpression is supplied then this update expression will be coalesced with any other update expressions
 * and added as a parameter to the write operation.
 */
@SdkPublicApi
@ThreadSafe
public final class WriteModification {
    private final Map transformedItem;
    private final Expression additionalConditionalExpression;
    private final UpdateExpression updateExpression;

    private WriteModification(Builder builder) {
        this.transformedItem = builder.transformedItem;
        this.additionalConditionalExpression = builder.additionalConditionalExpression;
        this.updateExpression = builder.updateExpression;
    }

    public static Builder builder() {
        return new Builder();
    }

    public Map transformedItem() {
        return transformedItem;
    }

    public Expression additionalConditionalExpression() {
        return additionalConditionalExpression;
    }

    public UpdateExpression updateExpression() {
        return updateExpression;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        WriteModification that = (WriteModification) o;

        if (transformedItem != null ? ! transformedItem.equals(that.transformedItem) : that.transformedItem != null) {
            return false;
        }
        if (additionalConditionalExpression != null ?
                ! additionalConditionalExpression.equals(that.additionalConditionalExpression) :
                that.additionalConditionalExpression != null) {
            return false;
        }

        return updateExpression != null ?
               updateExpression.equals(that.updateExpression) :
               that.updateExpression == null;
    }

    @Override
    public int hashCode() {
        int result = transformedItem != null ? transformedItem.hashCode() : 0;
        result = 31 * result + (additionalConditionalExpression != null ? additionalConditionalExpression.hashCode() : 0);
        result = 31 * result + (updateExpression != null ? updateExpression.hashCode() : 0);
        return result;
    }

    @NotThreadSafe
    public static final class Builder {
        private Map transformedItem;
        private Expression additionalConditionalExpression;
        private UpdateExpression updateExpression;

        private Builder() {
        }

        public Builder transformedItem(Map transformedItem) {
            this.transformedItem = transformedItem;
            return this;
        }

        public Builder additionalConditionalExpression(Expression additionalConditionalExpression) {
            this.additionalConditionalExpression = additionalConditionalExpression;
            return this;
        }

        public Builder updateExpression(UpdateExpression updateExpression) {
            this.updateExpression = updateExpression;
            return this;
        }

        public WriteModification build() {
            return new WriteModification(this);
        }
    }
}