jfxtras.icalendarfx.utilities.Pair Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jfxtras-all Show documentation
Miscellaneous components for JavaFX
The newest version!
package jfxtras.icalendarfx.utilities;

import java.io.Serializable;

import jfxtras.icalendarfx.utilities.Pair;

 /**
  * A convenience class to represent name-value pairs.
  * Copied from JavaFx for use in Java EE environments
  */
public class Pair implements Serializable{

    /**
     * Key of this Pair.
     */
    private K key;

    /**
     * Gets the key for this pair.
     * @return key for this pair
     */
    public K getKey() { return key; }

    /**
     * Value of this this Pair.
     */
    private V value;

    /**
     * Gets the value for this pair.
     * @return value for this pair
     */
    public V getValue() { return value; }

    /**
     * Creates a new pair
     * @param key The key for this pair
     * @param value The value to use for this pair
     */
    public Pair( K key, V value) {
        this.key = key;
        this.value = value;
    }

    /**
     * String representation of this
     * Pair.
     *
     * The default name/value delimiter '=' is always used.
     *
     *  @return String representation of this Pair
     */
    @Override
    public String toString() {
        return key + "=" + value;
    }

    /**
     * Generate a hash code for this Pair.
     *
     * The hash code is calculated using both the name and
     * the value of the Pair.
     *
     * @return hash code for this Pair
     */
    @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 key.hashCode() * 13 + (value == null ? 0 : value.hashCode());
    }

     /**
      * Test this Pair for equality with another
      * Object.
      *
      * If the Object to be tested is not a
      * Pair or is null, then this method
      * returns false.
      *
      * Two Pairs are considered equal if and only if
      * both the names and values are equal.
      *
      * @param o the Object to test for
      * equality with this Pair
      * @return true if the given Object is
      * equal to this Pair else false
      */
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o instanceof Pair) {
             Pair pair = (Pair) o;
             if (key != null ? !key.equals(pair.key) : pair.key != null) return false;
             if (value != null ? !value.equals(pair.value) : pair.value != null) return false;
             return true;
         }
         return false;
     }
 }