src/uk/ac/ntu/n0521366/wsyd/libs/WSYD_Member_Comparator_UserName.java

   1 /*
   2  * The MIT License
   3  *
   4  * Copyright 2015 Eddie Berrisford-Lynch <dev@fun2be.me>.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 package uk.ac.ntu.n0521366.wsyd.libs;
  25
  26 import java.io.Serializable;
  27 import java.util.Comparator;
  28
  29 /**
  30  * Order WSYD_Members by user name; usable by TreeSeti &lt;WSYD_Member&gt;> and other Collections.
  31  *
  32  * Implements serializable in order that the Collection using it doesn't cause
  33  * deserialize Exceptions due to missing Comparator
  34  *
  35  * @author Eddie Berrisford-Lynch <dev@fun2be.me>
  36  */
  37 public class WSYD_Member_Comparator_UserName implements Comparator<WSYD_Member>, Serializable {
  38     /**
  39      * Sorts alphabetically on username, low to high.
  40      *
  41      * @param m1
  42      * @param m2
  43      * @return -1 if m1 < m2, 0 if m1 == m2, 1 if m1 > m2
  44      */
  45     @Override
  46     public int compare(WSYD_Member m1, WSYD_Member m2) throws NullPointerException {
  47         if (m1 == null || m2 == null)
  48             throw new NullPointerException();
  49         return m1._userName.compareTo(m2._userName);
  50     }
  51 }