org.jboss.windup.config

Class SkipReportsRenderingOption

java.lang.Object

org.jboss.windup.config.AbstractConfigurationOption

org.jboss.windup.config.SkipReportsRenderingOption

All Implemented Interfaces:

ConfigurationOption

public class SkipReportsRenderingOption
extends AbstractConfigurationOption

Indicates whether Windup processing should render reports at all.

Author:

Marek Novotny

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
SkipReportsRenderingOption()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns descriptive text that may be more lengthy and descriptive (for example, "Excludes the specified Java packages from Windup's scans").
String	getLabel() Return a short amount of descriptive text regarding the option (for example, "Exclude Packages").
String	getName() Returns the name of the parameter.
Class<?>	getType() Returns the datatype for this Option (typically File, String, or List).
InputType	getUIType() Returns a type that can be used as a hint to indicate what type of user interface should be presented for this option.
boolean	isRequired() Indicates whether or not this option must be specified.
ValidationResult	validate(Object value) Validate the user indicated value and return the result.

Methods inherited from class org.jboss.windup.config.AbstractConfigurationOption

getAvailableValues, getDefaultValue, getPriority, setAvailableValues

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

SkipReportsRenderingOption

public SkipReportsRenderingOption()

Method Detail

getDescription

public String getDescription()

Description copied from interface: ConfigurationOption

Returns descriptive text that may be more lengthy and descriptive (for example, "Excludes the specified Java packages from Windup's scans").

getName

public String getName()

Description copied from interface: ConfigurationOption

Returns the name of the parameter. This should be a short name that is suitable for use in a command line parameter (for example, "packages" or "excludePackages").

getLabel

public String getLabel()

Description copied from interface: ConfigurationOption

Return a short amount of descriptive text regarding the option (for example, "Exclude Packages").

getType

public Class<?> getType()

Description copied from interface: ConfigurationOption

Returns the datatype for this Option (typically File, String, or List).

getUIType

public InputType getUIType()

Description copied from interface: ConfigurationOption

Returns a type that can be used as a hint to indicate what type of user interface should be presented for this option.

isRequired

public boolean isRequired()

Description copied from interface: ConfigurationOption

Indicates whether or not this option must be specified.

validate

public ValidationResult validate(Object value)

Description copied from interface: ConfigurationOption

Validate the user indicated value and return the result.