Addressbook/src/org/mxchange/addressbook/menu/item/console/ConsoleMenuItem.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.addressbook.menu.item.console;
  18
  19 import java.text.MessageFormat;
  20 import org.mxchange.addressbook.client.Client;
  21 import org.mxchange.addressbook.menu.item.BaseMenuItem;
  22 import org.mxchange.addressbook.menu.item.SelectableMenuItem;
  23
  24 /**
  25  *
  26  * @author Roland Haeder
  27  */
  28 public class ConsoleMenuItem extends BaseMenuItem implements SelectableMenuItem {
  29
  30         /**
  31          * Access key
  32          */
  33         private char accessKey;
  34
  35         /**
  36          * Text to user
  37          */
  38         private String text;
  39
  40         /**
  41          * Constructor for building a console menu with access key and text
  42          *
  43          * @param accessKey Access key for this menu entry
  44          * @param text Text to show to user
  45          */
  46         public ConsoleMenuItem (final char accessKey, final String text) {
  47                 this.setAccessKey(accessKey);
  48                 this.setText(text);
  49         }
  50
  51         /**
  52          * Access key
  53          *
  54          * @return the accessKey
  55          */
  56         @Override
  57         public final char getAccessKey () {
  58                 return this.accessKey;
  59         }
  60
  61         /**
  62          * Text to user
  63          *
  64          * @return the text
  65          */
  66         @Override
  67         public String getText () {
  68                 return this.text;
  69         }
  70
  71         @Override
  72         public void show (final Client client) {
  73                 // Trace message
  74                 this.getLogger().trace(MessageFormat.format("client={0} - CALLED!", client)); //NOI18N
  75
  76                 // Client must not be null
  77                 if (client == null) {
  78                         // Abort here
  79                         throw new NullPointerException("client is null");
  80                 }
  81
  82                 // Call-back client over menu
  83                 client.showEntry(this);
  84
  85                 // Trace message
  86                 this.getLogger().trace("EXIT!"); //NOI18N
  87         }
  88
  89         /**
  90          * Text to user
  91          *
  92          * @param text the text to set
  93          */
  94         private void setText (String text) {
  95                 this.text = text;
  96         }
  97
  98         /**
  99          * Access key
 100          *
 101          * @param accessKey the accessKey to set
 102          */
 103         private void setAccessKey (char accessKey) {
 104                 this.accessKey = accessKey;
 105         }
 106
 107 }