/*
Wotonomy: OpenStep design patterns for pure Java applications.
Copyright (C) 2002 Israfil consulting Services Corporation

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, see http://www.gnu.org

$Id: NSComparator.java 913 2006-03-10 00:52:27Z cgruber $

*/

package net.wotonomy.foundation;

import java.util.Comparator;

/**
 * An object that compares two other objects. As a convenience, it also
 * implements java.util.Comparator.
 *
 * @author cgruber@israfil.net
 * @author $Author: cgruber $
 * @version $Revision: 913 $
 */

public abstract class NSComparator<T> implements Comparator<T> {
	protected static class _NSSelectorComparator extends NSComparator<NSSelector> {

		@Override
		public int compare(NSSelector obj, NSSelector obj1) throws ComparisonException {
			throw new UnsupportedOperationException("Not Yet Implemented");
		}

		public _NSSelectorComparator(NSSelector nsselector) {
			throw new UnsupportedOperationException("Not Yet Implemented");
		}
	}

	private static class StandInComparator<T> extends NSComparator<T> {

		public StandInComparator() {
			throw new UnsupportedOperationException("Not Yet Implemented");
		}

		@Override
		public int compare(T obj, T obj1) throws ComparisonException {
			throw new UnsupportedOperationException("Not Yet Implemented");
		}

	}

	public static class ComparisonException extends ClassCastException {
		private static final long serialVersionUID = 8417668044508338674L;

		public ComparisonException(String s) {
			super(s);
		}
	}

	public static final NSComparator<String> AscendingStringComparator = new StandInComparator<>();
	public static final NSComparator<String> DescendingStringComparator = new StandInComparator<>();
	public static final NSComparator<String> AscendingCaseInsensitiveStringComparator = new StandInComparator<>();
	public static final NSComparator<String> DescendingCaseInsensitiveStringComparator = new StandInComparator<>();
	public static final NSComparator<String> AscendingNumberComparator = new StandInComparator<>();
	public static final NSComparator<String> DescendingNumberComparator = new StandInComparator<>();
	public static final NSComparator<String> AscendingTimestampComparator = new StandInComparator<>();
	public static final NSComparator<String> DescendingTimestampComparator = new StandInComparator<>();
	
	public static final int OrderedAscending = -1;
	public static final int OrderedSame = 0;
	public static final int OrderedDescending = 1;

	public NSComparator() {
	}

	@Override
	public abstract int compare(T obj, T obj1) throws ClassCastException;

	public static <T> int _compareObjects(Comparable<T> comparable, Comparable<T> comparable1) {
		throw new UnsupportedOperationException("Not Yet Implemented");
	}

}
/*
 * $Log$ Revision 1.2 2006/03/10 00:52:27 cgruber Add tests for NSArray and fix
 * some problems that became obvious as a result.
 *
 * Revision 1.1 2006/02/16 12:47:16 cgruber Check in all sources in
 * eclipse-friendly maven-enabled packages.
 *
 * Revision 1.1 2002/07/14 21:56:16 mpowers Contributions from cgruber.
 *
 * Revision 1.1 2002/06/25 07:52:56 cgruber Add quite a few abstract classes,
 * interfaces, and classes. All API consistent with WebObjects, but with no
 * implementation, nor any private or package access members from the original.
 *
 */