src/org/mxchange/addressbook/model/addressbook/status/AddressbokStatus.java

   1 /*
   2  * Copyright (C) 2016 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.addressbook.model.addressbook.status;
  18
  19 import java.io.Serializable;
  20
  21 /**
  22  * An enumeration for the addressbook status
  23  * <p>
  24  * @author Roland Haeder<roland@mxchange.org>
  25  */
  26 public enum AddressbokStatus implements Serializable {
  27
  28         /**
  29          * When the addressbook is unlocked
  30          */
  31         UNLOCKED("ADDRESSBOOK_STATUS_UNLOCKED"), //NOI18N
  32
  33         /**
  34          * When the addressbook is locked by administrator
  35          */
  36         LOCKED("ADDRESSBOOK_STATUS_LOCKED"); //NOI18N
  37
  38         /**
  39          * Message key
  40          */
  41         private final String messageKey;
  42
  43         /**
  44          * Constructor
  45          * <p>
  46          * @param messageKey Message key for this enum
  47          */
  48         private AddressbokStatus (final String messageKey) {
  49                 this.messageKey = messageKey;
  50         }
  51
  52         /**
  53          * Getter for message key
  54          * <p>
  55          * @return Message key
  56          */
  57         public String getMessageKey () {
  58                 return this.messageKey;
  59         }
  60 }