Pair.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Bc. Radim Loskot xlosko01@stud.fit.vutbr.cz
 * File: Pair.java
 * Description: Contains Java equivalent of C++ Pair or C# Tupple.
 */
/**
 * @file Pair.java
 *
 * @brief Contains Java equivalent of C++ Pair or C# Tupple.
 */

package cz.vutbr.fit.knot.annotations.document;

/**
 * Java equivalent of C++ Pair or C# Tupple.
 *
 * @brief Java equivalent of C++ Pair or C# Tupple.
 *
 * @author Bc. Radim Loskot (xlosko01 at stud.fit.vutbr.cz)
 */
public class Pair<L, R> {

  public L left;
  public R right;

  /**
   * Constructor
   */
  public Pair() {}
  
  /**
   * Constructor
   * 
   * @param left left pair
   * @param right right pair
   */
  public Pair(L left, R right) {
    this.left = left;
    this.right = right;
  } // Pair()

  /**
   * Equals if object is the same class instance and has same left and right values.
   * 
   * @param obj Object to compare
   * @return 
   */
  @Override
  public boolean equals(Object obj) {
    if (obj == null) {
      return false;
    }
    
    if (!(obj instanceof Pair)) {
      return false;
    }
    
    Pair pairObj = (Pair) obj;
    return left.equals(pairObj.left) && right.equals(pairObj.right);
  } // equals()

  /**
   * Returns hash code of this object.
   * 
   * @return Hash code
   */
  @Override
  public int hashCode() {
    return left.hashCode() ^ right.hashCode();
  } // hashCode()
};