Pair.java

/*
 * Copyright (c) 2007-2009, 2011-2013 Eike Stepper (Berlin, Germany) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Eike Stepper - initial API and implementation
 */
package org.eclipse.net4j.util.collection;

import org.eclipse.net4j.util.ObjectUtil;

/**
 * @author Eike Stepper
 */
public class Pair<T1, T2>
{
  private T1 element1;

  private T2 element2;

  public Pair()
  {
  }

  public Pair(T1 element1, T2 element2)
  {
    this.element1 = element1;
    this.element2 = element2;
  }

  /**
   * @since 2.0
   */
  public Pair(Pair<T1, T2> source)
  {
    element1 = source.element1;
    element2 = source.element2;
  }

  public final T1 getElement1()
  {
    return element1;
  }

  public void setElement1(T1 element1)
  {
    this.element1 = element1;
  }

  public final T2 getElement2()
  {
    return element2;
  }

  public void setElement2(T2 element2)
  {
    this.element2 = element2;
  }

  /**
   * @since 2.0
   */
  @Override
  public boolean equals(Object obj)
  {
    if (this == obj)
    {
      return true;
    }

    if (obj instanceof Pair<?, ?>)
    {
      Pair<?, ?> that = (Pair<?, ?>)obj;
      return ObjectUtil.equals(element1, that.getElement1()) && ObjectUtil.equals(element2, that.getElement2());
    }

    return false;
  }

  /**
   * @since 2.0
   */
  @Override
  public int hashCode()
  {
    return ObjectUtil.hashCode(element1) ^ ObjectUtil.hashCode(element2);
  }

  /**
   * @since 2.0
   */
  @Override
  public String toString()
  {
    return "Pair[" + element1 + ", " + element2 + "]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
  }

  /**
   * @since 3.3
   */
  public Pair<T1, T2> copy()
  {
    return new Pair<T1, T2>(this);
  }

  /**
   * @since 3.3
   */
  public static <T1, T2> Pair<T1, T2> create()
  {
    return new Pair<T1, T2>();
  }

  /**
   * @since 3.3
   */
  public static <T1, T2> Pair<T1, T2> create(T1 element1, T2 element2)
  {
    return new Pair<T1, T2>(element1, element2);
  }
}