Addressbook/src/org/mxchange/addressbook/menu/Menu.java

   1 /*\r
   2  * Copyright (C) 2015 Roland Haeder\r
   3  *\r
   4  * This program is free software: you can redistribute it and/or modify\r
   5  * it under the terms of the GNU General Public License as published by\r
   6  * the Free Software Foundation, either version 3 of the License, or\r
   7  * (at your option) any later version.\r
   8  *\r
   9  * This program is distributed in the hope that it will be useful,\r
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  12  * GNU General Public License for more details.\r
  13  *\r
  14  * You should have received a copy of the GNU General Public License\r
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  16  */\r
  17 package org.mxchange.addressbook.menu;\r
  18 \r
  19 import java.util.Iterator;\r
  20 import org.mxchange.addressbook.client.Client;\r
  21 import org.mxchange.addressbook.menu.item.SelectableMenuItem;\r
  22 \r
  23 /**\r
  24  *\r
  25  * @author Roland Haeder\r
  26  * @todo find better name\r
  27  */\r
  28 public interface Menu {\r
  29 \r
  30     /**\r
  31      * "Getter" for an iterator on all menu items of the current menu\r
  32      * @return Iterator on all menu items\r
  33      */\r
  34     public Iterator<SelectableMenuItem> getMenuItemsIterator();\r
  35 \r
  36     /**\r
  37      * Shows this menu\r
  38      * @param client Client instance\r
  39      */\r
  40     public void show (final Client client);\r
  41 \r
  42     /**\r
  43      * Size of all menu items\r
  44      * @return \r
  45      */\r
  46     public int getMenuItemsCount();\r
  47 }\r