EpicVouchers/src/main/java/com/craftaro/epicvouchers/utils/Pair.java

111 lines
2.9 KiB
Java

package com.craftaro.epicvouchers.utils;
import java.io.Serializable;
import java.util.Objects;
/**
* <p>A convenience class to represent name-value pairs.</p>
*
* @since JavaFX 2.0
*/
public class Pair<K, V> implements Serializable {
/**
* Key of this <code>Pair</code>.
*/
private final String key;
/**
* Gets the key for this pair.
*
* @return key for this pair
*/
public String getKey() {
return this.key;
}
/**
* Value of this this <code>Pair</code>.
*/
private final String value;
/**
* Gets the value for this pair.
*
* @return value for this pair
*/
public String getValue() {
return this.value;
}
/**
* Creates a new pair
*
* @param key The key for this pair
* @param value The value to use for this pair
*/
public Pair(String key, String value) {
this.key = key;
this.value = value;
}
/**
* <p><code>String</code> representation of this
* <code>Pair</code>.</p>
*
* <p>The default name/value delimiter '=' is always used.</p>
*
* @return <code>String</code> representation of this <code>Pair</code>
*/
@Override
public String toString() {
return this.key + "=" + this.value;
}
/**
* <p>Generate a hash code for this <code>Pair</code>.</p>
*
* <p>The hash code is calculated using both the name and
* the value of the <code>Pair</code>.</p>
*
* @return hash code for this <code>Pair</code>
*/
@Override
public int hashCode() {
// name's hashCode is multiplied by an arbitrary prime number (13)
// in order to make sure there is a difference in the hashCode between
// these two parameters:
// name: a value: aa
// name: aa value: a
return this.key.hashCode() * 13 + (this.value == null ? 0 : this.value.hashCode());
}
/**
* <p>Test this <code>Pair</code> for equality with another
* <code>Object</code>.</p>
*
* <p>If the <code>Object</code> to be tested is not a
* <code>Pair</code> or is <code>null</code>, then this method
* returns <code>false</code>.</p>
*
* <p>Two <code>Pair</code>s are considered equal if and only if
* both the names and values are equal.</p>
*
* @param o the <code>Object</code> to test for
* equality with this <code>Pair</code>
* @return <code>true</code> if the given <code>Object</code> is
* equal to this <code>Pair</code> else <code>false</code>
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Pair<?, ?> pair = (Pair<?, ?>) o;
return Objects.equals(this.key, pair.key) && Objects.equals(this.value, pair.value);
}
}