as2lib 0.9

     1  /*
     2   * Copyright the original author or authors.
     3   * 
     4   * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   * 
     8   *      http://www.mozilla.org/MPL/MPL-1.1.html
     9   * 
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  import org.as2lib.core.BasicInterface;
    18  
    19  /**
    20   * {@code Compareable} represents a class that has the ability to compare different
    21   * instances if they are equal.
    22   * 
    23   * <p>The == and the === operators ignore the fact that different instances of
    24   * the same class with the same value are equal. 
    25   * 
    26   * <p>{@code Comparable} allows to implement your own strategy to compare the
    27   * current instance with a different instance.
    28   * 
    29   * @author Martin Heidegger
    30   * @version 1.0
    31   * @see org.as2lib.util.ObjectUtil#compare
    32   */
    33  interface org.as2lib.util.Comparable extends BasicInterface {
    34  	
    35  	/**
    36  	 * Compares the instance with the passed-in {@code object}.
    37  	 * 
    38  	 * <p>The implementation compares the passed-in {@code object} if it represents
    39  	 * the same content as the current instance.
    40  	 * 
    41  	 * @return {@code true} if the passed-in {@code object} is equal to the instance.
    42  	 */
    43  	public function compare(object):Boolean;
    44  }