org.opencms.file.collectors.ComparatorInverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software GmbH & Co. KG, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.file.collectors;

import org.opencms.file.I_CmsResource;

import java.util.Comparator;

/**
 * Wrapper around a comparator that inverts comparison results which may e.g. be
 * used to invert sort orders. 
 *
 * This is used to create {@link java.util.SortedSet} instances that may
 * sort in different order (ascending vs. descending).

 *
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Internal comparator result Transformed result
-1 +1
0 0
+1 -1
 * 
 *
 * @since 7.0.3
 *
 */
public final class ComparatorInverter implements Comparator {

    /** The comparator to invert. */
    private Comparator m_delegate;

    /**
     * Creates a comparator that will invert the result of the given comparator.
     * 
     *
     * @param toInvert the comparator to invert results of
     */
    public ComparatorInverter(Comparator toInvert) {

        m_delegate = toInvert;
    }

    /**
     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
     */
    public int compare(I_CmsResource o1, I_CmsResource o2) {

        int result = m_delegate.compare(o1, o2);
        return -result;
    }
}