Constructors
Constructor and Description
`Menu()` Default constructor.
`Menu(java.lang.String menuTitle)` Constructor with title.

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOption(java.lang.String optionText)` Adds an option to the menu.
`void`	`display()` Displays the menu title and options, with a blank line between the title and the options.
`int`	`getChoice()` Same as the two-parameter version, except it uses a default prompt and a default maximum number of tries.
`int`	`getChoice(int maxNumberOfTries)` Same as the two-parameter version, except it uses the default prompt and the maximum number of tries input.
`int`	`getChoice(java.lang.String prompt)` Same as the two-parameter version, except it uses the input prompt and the default maximum number of tries, which is 3.
`int`	`getChoice(java.lang.String prompt, int maxNumberOfTries)` Prompts the user to enter a menu choice and then reads the choice entered by the user at the keyboard.
`void`	`setTitle(java.lang.String menuTitle)` Sets (or resets) the title of an already existing menu.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Menu
```
public Menu()
```
    Default constructor. Constructs a menu with zero options and a title of Empty Menu. Pre-conditions:
    None. Post-conditions:
    A Menu object has been contructed with the title "Empty Menu" and no options.
  - Menu
```
public Menu(java.lang.String menuTitle)
```
    Constructor with title. Constructs a menu with zero options and a title given by the input parameter. If that title exceeds 70 characters in length, the following message is output, followed by a pause, and the input title is overridden by the default title of Empty Menu:
```
 ===== Error: Title cannot exceed 70 characters.
 The title
 ... title that was too long goes here ...
 was not added to the menu.
 This menu has been given the default title: Empty Menu
 
```
    Parameters:
    
    menuTitle - The title to be given to the menu. Pre-conditions:
    None. Post-conditions:
    A Menu object has been contructed with a title and no options.
- Method Detail
  - setTitle
```
public void setTitle(java.lang.String menuTitle)
```
    Sets (or resets) the title of an already existing menu. If that title exceeds 70 characters in length, the following message is output, followed by a pause:
```
 ===== Error: Title length cannot exceed 70 characters.
 The title
 ... text of title that was too long appears here ...
 was not added to the menu.
 
```
    Parameters:
    
    menuTitle - The title to be given to the menu. Pre-conditions:
    This Menu object and menuTitle have been initialized. Post-conditions:
    The title of this Menu object has been set to the value in menuTitle, or a message has been displayed indicating that title was too long and original title has been retained.
  - addOption
```
public void addOption(java.lang.String optionText)
```
    Adds an option to the menu. The maximum number of options any menu can have is 20, and the maximum length of any option is 70 characters.
    If the number of options on the menu is already 20, the following message is displayed, followed by a pause:
```
 ===== Error: Maximum number of menu options (20) exceeded.
 The option
 ... text of option that could not be added goes here
 was not added to the menu.
 
```
    If the length of the option being added exceeds 70 characters, the following message is displayed, followed by a pause:
```
 ===== Error: Option cannot exceed 70 characters in length.
 The option
 ... text of option that was too long appears here ...
 was not added to the menu.
 
```
    Parameters:
    
    optionText - The text of the option to be added to the menu. Pre-conditions:
    This Menu object and optionText have been initialized. Post-conditions:
    The option in optionText has been added to this Menu object, and given the next available option number, or a message has been displayed indicating that the option was too long and the Menu object remains unchanged.
  - display
```
public void display()
```
    Displays the menu title and options, with a blank line between the title and the options. The menu is positioned more or less centered on the screen, with any "bias" toward the left and the top. If the menu currently has no options, the title is displayed, then a blank line, and then this line is displyed, starting at the left margin.
```
 This menu currently has no options.
 
```
    These three lines are centered vertically, more or less, on an otherwise blank screen. Pre-conditions:
    This Menu object has been initialized. Post-conditions:
    This Menu object has been displayed on the screen.
  - getChoice
```
public int getChoice(java.lang.String prompt,
                     int maxNumberOfTries)
```
    Prompts the user to enter a menu choice and then reads the choice entered by the user at the keyboard. If this method is called for a menu that has zero options, the following message is displayed, and the method returns a value of -1:
```
 ===== Error: Menu has no options from which to choose.
 
```
    If the user enters an invalid menu choice, the following message is displayed, and the user gets to make another choice, unless the maximum number of tries allowed has been reached:
```
 Error: Menu option choice invalid.
 Choice must be a value from 1 to #. Try again.
 
```
    Here # represents the maximum option number on the current menu. If the user makes the "maximum number of tries" invalid choices, the following message is displayed, and the method returns a value of -1:
```
 Sorry, but that last choice was also invalid, and you only get # chances.
 
```
    Here # represents the maximum number of tries the user is permitted to enter a valid menu option.
    If the user enters an empty string as a prompt, the prompt is set to
```
 Enter choice:
 
```
    and if the user enters a value < 2 for the maximum number of permitted tries, that value is set to 2.
    Parameters:
    
    prompt - The prompt used to ask the user for a menu choice.
    
    maxNumberOfTries - The maximum number of tries the user has to enter a valid menu choice. Pre-conditions:
    prompt and maxNumberOfTries are both initialized. Post-conditions:
    A valid menu choice has been returned, or one or more error messaqes have been displayed and a value of -1 has been returned.
    
    Returns:
    
    The choice entered by the user, or -1 if the user has not entered a valid choice after three tries.
  - getChoice
```
public int getChoice()
```
    Same as the two-parameter version, except it uses a default prompt and a default maximum number of tries. The default prompt is
```
 Enter the number of your menu choice here and then press Enter:
 
```
    and the default maximum number of tries is 3.
    Returns:
    
    The choice entered by the user, or -1 if the user has not entered a valid choice after three tries. Pre-conditions:
    None. Post-conditions:
    A valid menu choice has been returned, or one or more error messaqes have been displayed and a value of -1 has been returned.
  - getChoice
```
public int getChoice(java.lang.String prompt)
```
    Same as the two-parameter version, except it uses the input prompt and the default maximum number of tries, which is 3.
    
    Parameters:
    
    prompt - The prompt used to ask the user for a menu choice. Pre-conditions:
    prompt has been initialized. Post-conditions:
    A valid menu choice has been returned, or one or more error messaqes have been displayed and a value of -1 has been returned.
    
    Returns:
    
    The choice entered by the user, or -1 if the user has not entered a valid choice after three tries.
  - getChoice
```
public int getChoice(int maxNumberOfTries)
```
    Same as the two-parameter version, except it uses the default prompt and the maximum number of tries input.
    
    Parameters:
    
    maxNumberOfTries - The maximum number of tries the user has to enter a valid menu choice.
    
    Returns:
    
    The choice entered by the user, or -1 if the user has not entered a valid choice after maxNumberOfTries tries. Pre-conditions:
    maxNumberOfTries has been initialized. Post-conditions:
    A valid menu choice has been returned, or one or more error messaqes have been displayed and a value of -1 has been returned.

Class Menu

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Menu

Menu

Method Detail

setTitle

addOption

display

getChoice

getChoice

getChoice

getChoice