/* 
    P/P   *  Method: com.dmdirc.actions.ActionTypeComparator__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;
    24  
    25  import com.dmdirc.actions.interfaces.ActionType;
    26  
    27  import java.io.Serializable;
    28  import java.util.Comparator;
    29  
    30  /**
    31   * Implements a comparator for action types that compares their names.
    32   * 
    33   * @author Chris
    34   */
         /* 
    P/P   *  Method: int compare(Object, Object)
          * 
          *  Preconditions:
          *    x0 != null
          *    x1 != null
          *    (soft) x0.name != null
          * 
          *  Postconditions:
          *    init'ed(return_value)
          */
    35  public final class ActionTypeComparator implements Comparator<ActionType>, Serializable {
    36  
    37      /**
    38       * A version number for this class. It should be changed whenever the class
    39       * structure is changed (or anything else that would prevent serialized
    40       * objects being unserialized with the new class).
    41       */
    42      private static final long serialVersionUID = 1;        
    43      
    44      /**
    45       * Creates a new instance of ActionTypeComparator.
    46       */
             /* 
    P/P       *  Method: void com.dmdirc.actions.ActionTypeComparator()
              */
    47      public ActionTypeComparator() {
    48          // Do nothing
    49      }
    50  
    51      /** {@inheritDoc} */
    52      @Override
    53      public int compare(final ActionType o1, final ActionType o2) {
                 /* 
    P/P           *  Method: int compare(ActionType, ActionType)
                  * 
                  *  Preconditions:
                  *    o1 != null
                  *    o2 != null
                  *    (soft) o1.name != null
                  * 
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
    54          return o1.getName().compareTo(o2.getName());
    55      }
    56  
    57  }