View Javadoc

1   package org.apache.turbine.util;
2   
3   /*
4    * Copyright 2001-2005 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License")
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  /***
20   * Used by quicksort.
21   *
22   * @author <a href="mailto:mbryson@mindspring.com">Dave Bryson</a>
23   * @version $Id: Comparable.java 264148 2005-08-29 14:21:04Z henning $
24   * @deprecated This class will be removed after the 2.3 release. It is
25   *             not part of the Web Framework scope. If you need it, please
26   *             use a sorting library for quicksort.
27   */
28  public interface Comparable
29  {
30      /***
31       * Return the result of comparing two objects.
32       *
33       * @param obj1 First object.
34       * @param obj2 Second object.
35       * @return An int.
36       */
37      int compare(Object obj1,
38                  Object obj2);
39  }