KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > snipsnap > snip > storage > query > SnipComparator


1 /*
2  * This file is part of "SnipSnap Wiki/Weblog".
3  *
4  * Copyright (c) 2002 Stephan J. Schmidt, Matthias L. Jugel
5  * All Rights Reserved.
6  *
7  * Please visit http://snipsnap.org/ for updates and contact.
8  *
9  * --LICENSE NOTICE--
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23  * --LICENSE NOTICE--
24  */
25
26 package org.snipsnap.snip.storage.query;
27
28 import org.snipsnap.snip.Snip;
29
30 import java.util.Comparator JavaDoc;
31
32 /**
33  * Compares to snips for sorting
34  *
35  * @author Stephan J. Schmidt
36  * @version $Id: SnipComparator.java 815 2003-03-21 12:08:56Z stephan $
37  */
38
39 public abstract class SnipComparator implements Comparator JavaDoc {
40   /**
41    * Implementation of the Comparator interface compare method that
42    * takes to objects and casts them to snips
43    *
44    * @param o1 Snip to compare
45    * @param o2 Snip to compare
46    */
47   public int compare(Object JavaDoc o1, Object JavaDoc o2) {
48     if (!((o1 instanceof Snip) && (o2 instanceof Snip))) {
49       throw new ClassCastException JavaDoc();
50     }
51     return compare((Snip) o1, (Snip) o2);
52
53   }
54
55   /**
56    * Compares two snips according to the rules of the Comparator
57    * interface. This method is used for determing the sorting order
58    * of snips.
59    *
60    * @param s1 Snip to compare
61    * @param s2 Snip to compare
62    */
63   public abstract int compare(Snip s1, Snip s2);
64 }
65
Popular Tags