src/org/mxchange/jusercore/model/user/status/UserAccountStatus.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.jusercore.model.user.status;
  18
  19 import java.io.Serializable;
  20
  21 /**
  22  * An enum for user's account status like confirmed, locked, etc.
  23  * <p>
  24  * @author Roland Haeder
  25  */
  26 public enum UserAccountStatus implements Serializable {
  27
  28         /**
  29          * Unconfirmed (default)
  30          */
  31         UNCONFIRMED("USER_ACCOUNT_STATUS_UNCONFIRMED"), //NOI18N
  32
  33         /**
  34          * Confirmed (email address validated)
  35          */
  36         CONFIRMED("USER_ACCOUNT_STATUS_CONFIRMED"), //NOI18N
  37
  38         /**
  39          * Locked (maybe violeted T&C)
  40          */
  41         LOCKED("USER_ACCOUNT_STATUS_LOCKED"); //NOI18N
  42
  43         /**
  44          * Message key
  45          */
  46         private final String messageKey;
  47
  48         /**
  49          * Constructor with i18n translation key
  50          * <p>
  51          * @param messageKey Message key (i18n)
  52          */
  53         private UserAccountStatus (final String messageKey) {
  54                 // Set it here
  55                 this.messageKey = messageKey;
  56         }
  57
  58         /**
  59          * Output value (for messages)
  60          * <p>
  61          * @return the messageKey
  62          */
  63         public String getMessageKey () {
  64                 return this.messageKey;
  65         }
  66 }