/*
 This file is part of the software framework JStatCom, 
 a library for building applications for data based analysis.

 Copyright (C) 2000-2005  Markus Kraetzig

 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.

 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 com.jstatcom.util;

import java.util.Comparator;

/**
 * This class contains comparators that can be reused by other classes.
 * 

 * It implements the typesave enum pattern (Joshua Bloch, "Effective
 * Java", Item 21) . If you compare ComparatorTypes,
 * always use the == operator. This is save, because they are
 * Singletons (Gamma et al., 1995) .
 * 
 * @author Markus Kraetzig 
 */
public abstract class ComparatorTypes implements Comparator {
    /**
     * The name of the Comparator.
     */
    private final String name;

    /**
     * Compares two strings regardless of their case.
     */
    public static final ComparatorTypes STRING_DEFAULT = new ComparatorTypes(
            "STRING_DEFAULT") {
        public int compare(Object e1, Object e2) {
            String toComp1 = e1.toString().trim();
            String toComp2 = e2.toString().trim();
            int ret = toComp1.toUpperCase().compareTo(toComp2.toUpperCase());
            return ret;
        }
    };

    /**
     * ComparatorTypes constructor with a descriptive string.
     */
    protected ComparatorTypes(String name) {
        this.name = name;

    }

    /**
     * Override prevention method to enforce a.equals(b) if and
     * only if a==b.
     * 
     * @param o
     *            object to compare with
     * @return true if mainPeriod, subPeriod and subPeriodicity
     *         are the same, false otherwise
     */
    public final boolean equals(Object o) {
        return super.equals(o);
    }

    /**
     * Override prevention method invokes super method.
     * 
     * @return hash code
     */
    public final int hashCode() {
        return super.hashCode();
    }

    /**
     * Returns a string representation of this type, do not use for comparisons.
     * 
     * @return String representation of this object.
     */
    public final String toString() {
        return name;
    }
}
 
 


        
        

                    




        
      

      
Ads help maintain this website.