View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License. 
16   *
17   */
18  package org.apache.bcel.util;
19  
20  /**
21   * Used for BCEL comparison strategy
22   * 
23   * @author <A HREF="mailto:m.dahm@gmx.de">M. Dahm</A>
24   * @version $Id: BCELComparator.java 1158060 2011-08-15 23:17:19Z dbrosius $
25   * @since 5.2
26   */
27  public interface BCELComparator {
28  
29      /**
30       * Compare two objects and return what THIS.equals(THAT) should return
31       * 
32       * @param THIS
33       * @param THAT
34       * @return true if and only if THIS equals THAT
35       */
36      boolean equals( Object THIS, Object THAT );
37  
38  
39      /**
40       * Return hashcode for THIS.hashCode()
41       * 
42       * @param THIS
43       * @return hashcode for THIS.hashCode()
44       */
45      int hashCode( Object THIS );
46  }