001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.i18n;
029
030import java.io.Serializable;
031import java.util.Comparator;
032import java.util.Locale;
033
034/**
035 * Simple comparator implementation for locales, that compares the String value of the locales.<p>
036 *
037 * @since 6.0.0
038 */
039public final class CmsLocaleComparator implements Serializable, Comparator<Locale> {
040
041    /** Serial version UID required for safe serialization. */
042    private static final long serialVersionUID = -690619562147670465L;
043
044    /** Static locale comparator. */
045    private static final Comparator<Locale> LOCALE_COMPARATOR = new CmsLocaleComparator();
046
047    /**
048     * Hides the public constructor.<p>
049     */
050    private CmsLocaleComparator() {
051
052        // noop
053    }
054
055    /**
056     * Returns a static instance of the locale comparator.<p>
057     *
058     * @return a static instance of the locale comparator
059     */
060    public static Comparator<Locale> getComparator() {
061
062        return LOCALE_COMPARATOR;
063    }
064
065    /**
066     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
067     */
068    public int compare(Locale o1, Locale o2) {
069
070        return o1.toString().compareTo(o2.toString());
071    }
072}