/*\
 * Copyright  2006 Klaus Rogall, Hamburg, Germany (klaus.rogall@web.de). All rights reserved.
 * _____________________________________________________________________________________________________________________
 * 
 * This class is "Open Source" as defined by the Open Source Initiative (OSI). You can redistribute it and/or modify it
 * under the terms of the BSD License. The license text is appended to the end of this file.
\*/

package de.klaro.base.util;

import java.util.Comparator;


/**
 * Comparator, der Objekte anhand eines einfachen String-Vergleiches vergleicht.
 * 
 * @param  <T>	Der Typ der Objekte
 */

public class StringComparator<T extends Object> extends Object implements Comparator<T>
{

    /* ______________________________________________________________________________________________________________ *\
    \* Konstanten                                                                                                     */


    /* ______________________________________________________________________________________________________________ *\
    \* Klassenvariablen                                                                                               */


    /* ______________________________________________________________________________________________________________ *\
    \* Instanzvariablen                                                                                               */


    private boolean ascending$;


    /* ______________________________________________________________________________________________________________ *\
    \* Konstruktoren                                                                                                  */


    /**
     * Erzeugt einen aufsteigend sortierenden String-Comparator.
     */

    public StringComparator()
    {
        this(true);
    }


    /**
     * Erzeugt einen auf- oder absteigend sortierenden String-Comparator.
     *
     * @param  ascending        Die Sortierung ist aufsteigend
     */

    public StringComparator(boolean ascending)
    {
        super();

        ascending$ = ascending;
    }


    /* ______________________________________________________________________________________________________________ *\
    \* Instanzmethoden                                                                                                */


    /**
     * Vergleicht zwei Objekte, indem es eine String-Vergleich auf den 'toString'-Methoden ausfhrt.
     *
     * @param  a                Das erste Objekt
     * @param  b                Das zweite Objekt
     * @return                  Das Vergleichsergebnis entsprechend des 'Comparator'-Interfaces
     */

    public int compare(T a,T b)
    {
        return (ascending$)? a.toString().compareTo(b.toString()): b.toString().compareTo(a.toString());
    }


    /* ______________________________________________________________________________________________________________ *\
    \* Klassenmethoden                                                                                                */


    /* ______________________________________________________________________________________________________________ *\
    \* Klassen                                                                                                        */

}

/*\
 * _____________________________________________________________________________________________________________________
 * 
 * This software is distributed under the terms of the BSD License:
 * 
 * Copyright  2006 Klaus Rogall, Hamburg, Germany (klaus.rogall@web.de). All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, this list of conditions and the following
 *   disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided with the distribution.
 * - Neither the name of the Klaus Rogall nor the names of its contributors may be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *   
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * _____________________________________________________________________________________________________________________
\*/