com.amazonaws.services.dynamodbv2.model.DeleteRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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 request to perform a DeleteItem operation on an
* item.
*
*/
public class DeleteRequest implements Serializable {
/**
* A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*/
private java.util.Map key;
/**
* Default constructor for a new DeleteRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DeleteRequest() {}
/**
* Constructs a new DeleteRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param key A map of attribute name to attribute values, representing
* the primary key of the item to delete. All of the table's primary key
* attributes must be specified, and their data types must match those of
* the table's key schema.
*/
public DeleteRequest(java.util.Map key) {
setKey(key);
}
/**
* A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*
* @return A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*/
public java.util.Map getKey() {
return key;
}
/**
* A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*
* @param key A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*/
public void setKey(java.util.Map key) {
this.key = key;
}
/**
* A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param key A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DeleteRequest withKey(java.util.Map key) {
setKey(key);
return this;
}
/**
* A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*
* This method accepts the hashKey, rangeKey of Key as
* java.util.Map.Entry objects.
*
* @param hashKey Primary hash key.
* @param rangeKey Primary range key. (null if it a hash-only table)
*/
public void setKey(java.util.Map.Entry hashKey, java.util.Map.Entry rangeKey) throws IllegalArgumentException {
java.util.HashMap key = new java.util.HashMap();
if (hashKey != null) {
key.put(hashKey.getKey(), hashKey.getValue());
} else
throw new IllegalArgumentException("hashKey must be non-null object.");
if (rangeKey != null) {
key.put(rangeKey.getKey(), rangeKey.getValue());
}
setKey(key);
}
/**
* A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*
* This method accepts the hashKey, rangeKey of Key as
* java.util.Map.Entry objects.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param hashKey Primary hash key.
* @param rangeKey Primary range key. (null if it a hash-only table)
*/
public DeleteRequest withKey(java.util.Map.Entry hashKey, java.util.Map.Entry rangeKey) throws IllegalArgumentException {
setKey(hashKey, rangeKey);
return this;
}
/**
* A map of attribute name to attribute values, representing the primary
* key of the item to delete. All of the table's primary key attributes
* must be specified, and their data types must match those of the
* table's key schema.
*
* The method adds a new key-value pair into Key parameter, and returns a
* reference to this object so that method calls can be chained together.
*
* @param key The key of the entry to be added into Key.
* @param value The corresponding value of the entry to be added into Key.
*/
public DeleteRequest addKeyEntry(String key, AttributeValue value) {
if (null == this.key) {
this.key = new java.util.HashMap();
}
if (this.key.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.key.put(key, value);
return this;
}
/**
* Removes all the entries added into Key.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public DeleteRequest clearKeyEntries() {
this.key = null;
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 (getKey() != null) sb.append("Key: " + getKey() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DeleteRequest == false) return false;
DeleteRequest other = (DeleteRequest)obj;
if (other.getKey() == null ^ this.getKey() == null) return false;
if (other.getKey() != null && other.getKey().equals(this.getKey()) == false) return false;
return true;
}
}