io.github.astrapi69.collection.comparators.KeyValuePairKeyComparator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of silly-beans Show documentation

Utility library that provides some generic data beans like pair, triple and quattro

The newest version!

/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package io.github.astrapi69.collection.comparators;

import java.util.Comparator;

import io.github.astrapi69.collections.pairs.KeyValuePair;

/**
 * The class {@link KeyValuePairKeyComparator} compares {@linkplain KeyValuePair} objects over the
 * key where the key have to implements the {@linkplain Comparable} interface.
 *
 * @param 
 *            The generic type of the key
 * @param 
 *            The generic type of the value
 */
public class KeyValuePairKeyComparator, V>
	implements
		Comparator>
{

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int compare(final KeyValuePair o1, final KeyValuePair o2)
	{
		return o1.getKey().compareTo(o2.getKey());
	}
}