at.molindo.utils.data.Pair Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of molindo-utils Show documentation
Simply utility methods used across other Molindo projects
There is a newer version: 3.0.0
/**
 * Copyright 2010 Molindo GmbH
 *
 * 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 at.molindo.utils.data;

import java.io.Serializable;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map.Entry;

import at.molindo.utils.collections.CollectionBuilder;

public class Pair implements Serializable {

	private static final long serialVersionUID = 1L;

	public static  HashMap toHashMap(final List> pairs) {
		final HashMap map = new HashMap();
		for (final Pair pair : pairs) {
			map.put(pair.getKey(), pair.getValue());
		}
		return map;
	}

	public static Object[] keys(PairList c) {
		return keys(Object.class, c);
	}

	public static  T[] keys(Class cls, PairList c) {
		@SuppressWarnings("unchecked")
		T[] a = (T[]) Array.newInstance(cls, c.size());

		int i = 0;
		for (Pair p : c) {
			a[i++] = p.getKey();
		}
		return a;
	}

	public static Object[] values(PairList c) {
		return values(Object.class, c);
	}

	public static  T[] values(Class cls, PairList c) {
		@SuppressWarnings("unchecked")
		T[] a = (T[]) Array.newInstance(cls, c.size());

		int i = 0;
		for (Pair p : c) {
			a[i++] = p.getValue();
		}
		return a;
	}

	private A _first;

	private B _second;

	/**
	 * utility method to create pairs with implicit parameterization
	 * 
	 * @param 
	 * @param 
	 * @param key
	 * @param val
	 * @return
	 */
	public static  Pair pair(final K key, final V val) {
		return new Pair(key, val);
	}

	/**
	 * utility method to create pairs with implicit parameterization
	 * 
	 * @param 
	 * @param 
	 * @return
	 */
	public static  Pair pair() {
		return new Pair();
	}

	public static  PairCollectionBuilder pairs(Class kv) {
		return pairs(kv, kv);
	}

	public static  PairCollectionBuilder pairs(K k, V v) {
		PairCollectionBuilder pairs = pairs();
		pairs.pair(k, v);
		return pairs;
	}

	public static  PairCollectionBuilder pairs(Class k, Class v) {
		return pairs();
	}

	public static  PairCollectionBuilder pairs() {
		return new PairCollectionBuilder();
	}

	/**
	 * Contructs a pair holding two null values.
	 */
	public Pair() {
		_first = null;
		_second = null;
	}

	/**
	 * Contructs a pair holding the given objects.
	 */
	public Pair(final A a, final B b) {
		_first = a;
		_second = b;
	}

	/**
	 * Contructs a pair holding the objects of the given pair.
	 */
	public Pair(final Pair p) {
		_first = p.getFirst();
		_second = p.getSecond();
	}

	public Pair(final Entry e) {
		_first = e.getKey();
		_second = e.getValue();
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + (_first == null ? 0 : _first.hashCode());
		result = prime * result + (_second == null ? 0 : _second.hashCode());
		return result;
	}

	@Override
	public boolean equals(final Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		if (!(obj instanceof Pair)) {
			return false;
		}
		final Pair other = (Pair) obj;
		if (_first == null) {
			if (other._first != null) {
				return false;
			}
		} else if (!_first.equals(other._first)) {
			return false;
		}
		if (_second == null) {
			if (other._second != null) {
				return false;
			}
		} else if (!_second.equals(other._second)) {
			return false;
		}
		return true;
	}

	public A getFirst() {
		return _first;
	}

	public void setFirst(final A first) {
		_first = first;
	}

	public B getSecond() {
		return _second;
	}

	public void setSecond(final B second) {
		_second = second;
	}

	// alias for getSecond, inspired by Map.Entry
	public B getValue() {
		return getSecond();
	}

	// alias for getFirst, inspired by Map.Entry
	public A getKey() {
		return getFirst();
	}

	@Override
	public String toString() {
		return "['" + getKey() + "' = '" + getValue() + "']";
	}

	public static class PairCollectionBuilder extends CollectionBuilder, List>> {

		protected PairCollectionBuilder() {
			super(new ArrayList>());
		}

		public PairCollectionBuilder pair(K key, V value) {
			add(Pair.pair(key, value));
			return this;
		}
	}
}