001    /*--------------------------------------------------------------------------+
002    $Id: InvertingComparator.java 26283 2010-02-18 11:18:57Z juergens $
003    |                                                                          |
004    | Copyright 2005-2010 Technische Universitaet Muenchen                     |
005    |                                                                          |
006    | Licensed under the Apache License, Version 2.0 (the "License");          |
007    | you may not use this file except in compliance with the License.         |
008    | You may obtain a copy of the License at                                  |
009    |                                                                          |
010    |    http://www.apache.org/licenses/LICENSE-2.0                            |
011    |                                                                          |
012    | Unless required by applicable law or agreed to in writing, software      |
013    | distributed under the License is distributed on an "AS IS" BASIS,        |
014    | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
015    | See the License for the specific language governing permissions and      |
016    | limitations under the License.                                           |
017    +--------------------------------------------------------------------------*/
018    package edu.tum.cs.commons.collections;
019    
020    import java.util.Comparator;
021    
022    /**
023     * This works on another compartor and inverts it.
024     * 
025     * 
026     * @author Florian Deissenboeck
027     * @author $Author: juergens $
028     * @version $Rev: 26283 $
029     * @levd.rating GREEN Hash: 01BC540BD434B1257367A856516E7F2E
030     */
031    public class InvertingComparator<E> implements Comparator<E> {
032    
033        /** The underlying comparator */
034        private final Comparator<? super E> comparator;
035    
036        /**
037         * Create a new <code>InvertingComparator</code>.
038         * 
039         * @param comparator
040         *            the comparator to invert.
041         */
042        public InvertingComparator(Comparator<? super E> comparator) {
043            this.comparator = comparator;
044        }
045    
046        /**
047         * Compares to objects with the orginal comparator and inverts the result. *
048         */
049        public int compare(E object1, E object2) {
050            return -1 * comparator.compare(object1, object2);
051        }
052    
053    }