ScoreComparator.java

/**
 * Copyright 1999-2009 The Pegadi Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * This class compares two Scores.
 * @author Håvard Wigtil <havardw at pvv.org>
 * @version 0.1
 */
package org.pegadi.games;

import java.util.Comparator;

public class ScoreComparator implements Comparator<Score> {

    /**
     * Compare two Score objects. This sorting is inversed (smaller scores are
     * better) to place the highest scores first.<br>
     *
     * An <code>IllegalArgumentException</code> is
     * thrown if one or both of the objects aren't Score objects.
     *
     * @see org.pegadi.games.Score
     */
    public int compare(Score o1, Score o2) {
        return (int) (o2.getScore() - o1.getScore());
    }
}