Package com.sun.identity.install.tools.configurator

Class UserOptionItem

java.lang.Object

com.sun.identity.install.tools.configurator.UserOptionItem

public class UserOptionItem
extends Object

Class that encapulates a UserOption. A UserOption is an option displayed to the user. One or more of these UserOption's may be a part of an interaction.
EXAMPLES:
Interaction Example 1:

   1. Continue with installation 
   2. Start Over 
   3. Exit
 

Here 1, 2 & 3 are display items and the rest of the Strings are localized messages for each of those option. The localized message will be of the format:
{0}. Continue with installation
Interaction Example 2:
[ ? : Help, < : Back, ]
Here ? and < are display items. The localized messages will looks like

   {0} : Help
   {0} : Back
 

Constructor Summary

Constructors

Constructor	Description
UserOptionItem(String displayItem, String i18NKey)
UserOptionItem(String displayItem, String i18NKey, String i18NHelpKey)

Method Summary

Modifier and Type	Method	Description
boolean	equals(String userInputItem)
protected String	getDisplayItem()
LocalizedMessage	getDisplayMessage()
LocalizedMessage	getHelpMessage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserOptionItem

public UserOptionItem(String displayItem,
                      String i18NKey)

UserOptionItem

public UserOptionItem(String displayItem,
                      String i18NKey,
                      String i18NHelpKey)

Method Detail

equals

public boolean equals(String userInputItem)

getDisplayMessage

public LocalizedMessage getDisplayMessage()

getHelpMessage

public LocalizedMessage getHelpMessage()

getDisplayItem

protected String getDisplayItem()