de.alpharogroup.comparators.LocaleComparator Maven / Gradle / Ivy

Go to download
/**
 * 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 de.alpharogroup.comparators;

import java.util.Comparator;
import java.util.Locale;

/**
 * The class {@link LocaleComparator} compares {@linkplain Locale} objects. This Comparator does not
 * check null, for null check you can decorate it with the
 * {@link NullCheckComparator#of(Comparator)}. an example is in the unit test class from
 * {@linkplain NullCheckComparator}.
 */
public class LocaleComparator implements Comparator
{

	/**
	 * Factory method to create a new {@link LocaleComparator} object.
	 *
	 * @return the new {@link LocaleComparator} object
	 */
	public static Comparator of()
	{
		return LocaleComparator.of(false);
	}

	/**
	 * Factory method to create a new {@link LocaleComparator} object.
	 *
	 * @param nullIsGreaterThan
	 *            the flag that specifies if null objects is greater than non null objects.
	 * @return the new {@link LocaleComparator} object
	 */
	public static Comparator of(boolean nullIsGreaterThan)
	{
		return NullCheckComparator. of(new LocaleComparator(), nullIsGreaterThan);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int compare(Locale o1, Locale o2)
	{
		return o1.toString().compareTo(o2.toString());
	}

}