/* 
    P/P   *  Method: int compare(Object, Object)
          * 
          *  Preconditions:
          *    Param_1 != null
          *    Param_1.name != null
          *    Param_2 != null
          *    init'ed(Param_2.name)
          * 
          *  Postconditions:
          *    init'ed(return_value)
          */
     1  /*
     2   * Copyright (c) 2003-2006, Simon Brown
     3   * All rights reserved.
     4   *
     5   * Redistribution and use in source and binary forms, with or without
     6   * modification, are permitted provided that the following conditions are met:
     7   *
     8   *   - Redistributions of source code must retain the above copyright
     9   *     notice, this list of conditions and the following disclaimer.
    10   *
    11   *   - Redistributions in binary form must reproduce the above copyright
    12   *     notice, this list of conditions and the following disclaimer in
    13   *     the documentation and/or other materials provided with the
    14   *     distribution.
    15   *
    16   *   - Neither the name of Pebble nor the names of its contributors may
    17   *     be used to endorse or promote products derived from this software
    18   *     without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    30   * POSSIBILITY OF SUCH DAMAGE.
    31   */
    32  package net.sourceforge.pebble.comparator;
    33  
    34  import net.sourceforge.pebble.domain.StaticPage;
    35  
    36  import java.util.Comparator;
    37  
    38  /**
    39   * A comparator used to order StaticPage instances, in alphabetical order of
    40   * their names.
    41   *
    42   * @author    Simon Brown
    43   */
         /* 
    P/P   *  Method: void net.sourceforge.pebble.comparator.StaticPageByNameComparator()
          */
    44  public class StaticPageByNameComparator implements Comparator<StaticPage> {
    45  
    46    /**
    47     * Compares two objects.
    48     *
    49     * @param sp1   static page 1
    50     * @param sp2   static page 2
    51     * @return  -n, 0 or +n if the title of the first blog entry is less than,
    52     *          the same as or greater than the second, respectively
    53     */
    54    public int compare(StaticPage sp1, StaticPage sp2) {
             /* 
    P/P       *  Method: int compare(StaticPage, StaticPage)
              * 
              *  Preconditions:
              *    sp1 != null
              *    sp1.name != null
              *    sp2 != null
              *    init'ed(sp2.name)
              * 
              *  Postconditions:
              *    init'ed(return_value)
              */
    55      return sp1.getName().compareToIgnoreCase(sp2.getName());
    56    }
    57  
    58  }