/* 
    P/P   *  Method: com.dmdirc.actions.interfaces.ActionComparison__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.actions.interfaces;
    24  
    25  /**
    26   * Describes the methods that must be implemented by an action comparison.
    27   * Action comparisons allow the user to compare an action component to a
    28   * string they entered.
    29   * @author chris
    30   */
    31  public interface ActionComparison {
    32      
    33      /**
    34       * Tests the specified arguments against each other.
    35       * @param arg1 The first argument
    36       * @param arg2 The second argument
    37       * @return True iff the comparison between the args succeeds, false
    38       * otherwise
    39       */
    40      boolean test(final Object arg1, final Object arg2);
    41      
    42      /**
    43       * Returns the class that this comparison deals with.
    44       * @return The Class that this comparison can compare
    45       */
    46      Class appliesTo();
    47      
    48      /**
    49       * Returns a friendly name for this comparison.
    50       * @return This comparion's name
    51       */
    52      String getName();
    53      
    54  }