Package org.jboss.windup.bootstrap.help

Class OptionDescription

java.lang.Object

org.jboss.windup.bootstrap.help.OptionDescription

public class OptionDescription
extends Object

Represents a potential parameter to the Windup engine.

Author:

Jesse Sightler

Constructor Summary

Constructors

Constructor	Description
OptionDescription(String name, String description, String type, String uiType)	Creates an OptionDescription with the specified name, description, type, and UI Type (select one, select many, etc).
OptionDescription(String name, String description, String type, String uiType, List<String> availableOptions, boolean required)	Creates an OptionDescription with the specified name, description, type, UI Type (select one, select many, etc), and available option list.

Method Summary

Modifier and Type	Method	Description
List<String>	getAvailableOptions()	Gets a list of all available options.
String	getDescription()	Gets the description of the option.
String	getName()	Gets the name of the option.
String	getType()	Gets the type of the option.
String	getUiType()	Gets the UI Type (SELECT_ONE, SELECT_MANY, etc).
boolean	isRequired()	Tells if the option is required.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionDescription

public OptionDescription(String name,
                         String description,
                         String type,
                         String uiType)

Creates an OptionDescription with the specified name, description, type, and UI Type (select one, select many, etc). The available options is unbounded.

OptionDescription

public OptionDescription(String name,
                         String description,
                         String type,
                         String uiType,
                         List<String> availableOptions,
                         boolean required)

Creates an OptionDescription with the specified name, description, type, UI Type (select one, select many, etc), and available option list.

Method Detail

getName

public String getName()

Gets the name of the option.

getDescription

public String getDescription()

Gets the description of the option.

getType

public String getType()

Gets the type of the option.

getUiType

public String getUiType()

Gets the UI Type (SELECT_ONE, SELECT_MANY, etc).

getAvailableOptions

public List<String> getAvailableOptions()

Gets a list of all available options.

isRequired

public boolean isRequired()

Tells if the option is required.