src/org/mxchange/jcore/model/contact/gender/GenderUtils.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jcore.model.contact.gender;
  18
  19 import java.text.MessageFormat;
  20 import java.util.LinkedList;
  21 import java.util.List;
  22 import org.mxchange.jcore.BaseFrameworkSystem;
  23 import org.mxchange.jcore.model.contact.Contact;
  24
  25 /**
  26  * Gender utils class
  27  * <p>
  28  * @author Roland Haeder<roland@mxchange.org>
  29  */
  30 public class GenderUtils extends BaseFrameworkSystem {
  31
  32         /**
  33          * Translates contact's gender to human-readable
  34          * <p>
  35          * @param contact Contact instance
  36          * @return Translates value (from bundle)
  37          */
  38         public static String getTranslatedGender (final Contact contact) {
  39                 // Init instance
  40                 GenderUtils utils = new GenderUtils();
  41
  42                 // contact must be set
  43                 if (null == contact) {
  44                         // Abort here
  45                         throw new NullPointerException("contact is null");
  46                 } else if (contact.getGender() == null) {
  47                         // Gender is not set
  48                         throw new NullPointerException(MessageFormat.format("contact {0} has no gender set.", contact));
  49                 }
  50
  51                 // Get key from it
  52                 String key = contact.getGender().getMessageKey();
  53
  54                 // Translate and return it
  55                 return utils.getMessageStringFromKey(key);
  56         }
  57
  58         /**
  59          * Private contructor as this is an utility class
  60          */
  61         private GenderUtils () {
  62         }
  63
  64         /**
  65          * All selectable genders (not UNKNOWN)
  66          * <p>
  67          * @return Selectable genders (not UNKNOWN)
  68          */
  69         public static List<Gender> selectableGenders () {
  70                 // Init list
  71                 List<Gender> list = new LinkedList<>();
  72
  73                 // Walk through all genders
  74                 for (final Gender gender : Gender.values()) {
  75                         // Is it not UNKNOWN
  76                         if (!gender.equals(Gender.UNKNOWN)) {
  77                                 // Add it
  78                                 boolean added = list.add(gender);
  79
  80                                 // Has it been added?
  81                                 assert (added) : MessageFormat.format("gender {0} not added.", gender); //NOI18N
  82                         }
  83                 }
  84
  85                 // Return it
  86                 return list;
  87         }
  88 }