com.amazonaws.services.dynamodb.model.Key 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.dynamodb.model;
import java.io.Serializable;
/**
*
* The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute
* (hash-and-range) primary key.
*
* @deprecated This class is no longer supported by the latest service API.
*/
@Deprecated
public class Key implements Serializable {
/**
* A hash key element is treated as the primary key, and can be a string
* or a number. Single attribute primary keys have one index value. The
* value can be String, Number,
* StringSet, NumberSet.
*/
private AttributeValue hashKeyElement;
/**
* A range key element is treated as a secondary key (used in conjunction
* with the primary key), and can be a string or a number, and is only
* used for hash-and-range primary keys. The value can be
* String, Number, StringSet,
* NumberSet.
*/
private AttributeValue rangeKeyElement;
/**
* Default constructor for a new Key object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public Key() {}
/**
* Constructs a new Key object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param hashKeyElement A hash key element is treated as the primary
* key, and can be a string or a number. Single attribute primary keys
* have one index value. The value can be String,
* Number, StringSet, NumberSet.
*/
public Key(AttributeValue hashKeyElement) {
this.hashKeyElement = hashKeyElement;
}
/**
* Constructs a new Key object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param hashKeyElement A hash key element is treated as the primary
* key, and can be a string or a number. Single attribute primary keys
* have one index value. The value can be String,
* Number, StringSet, NumberSet.
* @param rangeKeyElement A range key element is treated as a secondary
* key (used in conjunction with the primary key), and can be a string or
* a number, and is only used for hash-and-range primary keys. The value
* can be String, Number,
* StringSet, NumberSet.
*/
public Key(AttributeValue hashKeyElement, AttributeValue rangeKeyElement) {
this.hashKeyElement = hashKeyElement;
this.rangeKeyElement = rangeKeyElement;
}
/**
* A hash key element is treated as the primary key, and can be a string
* or a number. Single attribute primary keys have one index value. The
* value can be String, Number,
* StringSet, NumberSet.
*
* @return A hash key element is treated as the primary key, and can be a string
* or a number. Single attribute primary keys have one index value. The
* value can be String, Number,
* StringSet, NumberSet.
*/
public AttributeValue getHashKeyElement() {
return hashKeyElement;
}
/**
* A hash key element is treated as the primary key, and can be a string
* or a number. Single attribute primary keys have one index value. The
* value can be String, Number,
* StringSet, NumberSet.
*
* @param hashKeyElement A hash key element is treated as the primary key, and can be a string
* or a number. Single attribute primary keys have one index value. The
* value can be String, Number,
* StringSet, NumberSet.
*/
public void setHashKeyElement(AttributeValue hashKeyElement) {
this.hashKeyElement = hashKeyElement;
}
/**
* A hash key element is treated as the primary key, and can be a string
* or a number. Single attribute primary keys have one index value. The
* value can be String, Number,
* StringSet, NumberSet.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param hashKeyElement A hash key element is treated as the primary key, and can be a string
* or a number. Single attribute primary keys have one index value. The
* value can be String, Number,
* StringSet, NumberSet.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public Key withHashKeyElement(AttributeValue hashKeyElement) {
this.hashKeyElement = hashKeyElement;
return this;
}
/**
* A range key element is treated as a secondary key (used in conjunction
* with the primary key), and can be a string or a number, and is only
* used for hash-and-range primary keys. The value can be
* String, Number, StringSet,
* NumberSet.
*
* @return A range key element is treated as a secondary key (used in conjunction
* with the primary key), and can be a string or a number, and is only
* used for hash-and-range primary keys. The value can be
* String, Number, StringSet,
* NumberSet.
*/
public AttributeValue getRangeKeyElement() {
return rangeKeyElement;
}
/**
* A range key element is treated as a secondary key (used in conjunction
* with the primary key), and can be a string or a number, and is only
* used for hash-and-range primary keys. The value can be
* String, Number, StringSet,
* NumberSet.
*
* @param rangeKeyElement A range key element is treated as a secondary key (used in conjunction
* with the primary key), and can be a string or a number, and is only
* used for hash-and-range primary keys. The value can be
* String, Number, StringSet,
* NumberSet.
*/
public void setRangeKeyElement(AttributeValue rangeKeyElement) {
this.rangeKeyElement = rangeKeyElement;
}
/**
* A range key element is treated as a secondary key (used in conjunction
* with the primary key), and can be a string or a number, and is only
* used for hash-and-range primary keys. The value can be
* String, Number, StringSet,
* NumberSet.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param rangeKeyElement A range key element is treated as a secondary key (used in conjunction
* with the primary key), and can be a string or a number, and is only
* used for hash-and-range primary keys. The value can be
* String, Number, StringSet,
* NumberSet.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public Key withRangeKeyElement(AttributeValue rangeKeyElement) {
this.rangeKeyElement = rangeKeyElement;
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 (getHashKeyElement() != null) sb.append("HashKeyElement: " + getHashKeyElement() + ", ");
if (getRangeKeyElement() != null) sb.append("RangeKeyElement: " + getRangeKeyElement() + ", ");
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getHashKeyElement() == null) ? 0 : getHashKeyElement().hashCode());
hashCode = prime * hashCode + ((getRangeKeyElement() == null) ? 0 : getRangeKeyElement().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof Key == false) return false;
Key other = (Key)obj;
if (other.getHashKeyElement() == null ^ this.getHashKeyElement() == null) return false;
if (other.getHashKeyElement() != null && other.getHashKeyElement().equals(this.getHashKeyElement()) == false) return false;
if (other.getRangeKeyElement() == null ^ this.getRangeKeyElement() == null) return false;
if (other.getRangeKeyElement() != null && other.getRangeKeyElement().equals(this.getRangeKeyElement()) == false) return false;
return true;
}
}