All Downloads are FREE. Search and download functionalities are using the official Maven repository.

ix.Pair Maven / Gradle / Ivy

There is a newer version: 1.0.0
Show newest version
/*
 * Copyright 2011-2016 David Karnok
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 ix;

/**
 * A pair of two objects.
 * @param  the first type
 * @param  the second type
 */
public final class Pair {
	/** The first object. */
	public final T first;
	/** The second object. */
	public final U second;
	/**
	 * Construct a pair.
	 * @param first the first object
	 * @param second the second object
	 */
	public Pair(T first, U second) {
		this.first = first;
		this.second = second;
	}
	/**
	 * Construct a pair.
	 * @param  the first type
	 * @param  the second type
	 * @param first the first object
	 * @param second the second object
	 * @return the pair
	 */
	public static  Pair of(T first, U second) {
		return new Pair(first, second);
	}
	@Override
	public boolean equals(Object obj) {
		if (obj instanceof Pair) {
			Pair that = (Pair)obj;
			return 
			(this.first == that.first || (this.first != null && this.first.equals(that.first)))
			&& (this.second == that.second || (this.second != null && this.second.equals(that.second)));
		}
		return false;
	}
	@Override
	public int hashCode() {
		return (17 + (first != null ? first.hashCode() : 0)) * 31 + (second != null ? second.hashCode() : 0);
	}
	@Override
	public String toString() {
		return "(" + first + ", " + second + ")";
	}
}