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

   1 /*
   2  * Copyright (C) 2016 - 2024 Free Software Foundation
   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;
  18
  19 import java.util.Iterator;
  20 import org.mxchange.addressbook.menu.item.SelectableMenuItem;
  21 import org.mxchange.jcore.client.Client;
  22
  23 /**
  24  * An interface for menus
  25  * <p>
  26  * @author Roland Häder<roland@mxchange.org> TODO find better name
  27  */
  28 public interface Menu {
  29
  30         /**
  31          * Size of all menu items
  32          * <p>
  33          * @return
  34          */
  35         int getMenuItemsCount ();
  36
  37         /**
  38          * "Getter" for an iterator on all menu items of the current menu
  39          * <p>
  40          * @return Iterator on all menu items
  41          */
  42         Iterator<SelectableMenuItem> getMenuItemsIterator ();
  43
  44         /**
  45          * Shows this menu
  46          * <p>
  47          * @param client Client instance
  48          */
  49         void show (final Client client);
  50 }