Package org.ossreviewtoolkit.plugins.api
Class PluginOption
-
- All Implemented Interfaces:
public final class PluginOptionA configuration option for a plugin.
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringnameprivate final Stringdescriptionprivate final PluginOptionTypetypeprivate final StringdefaultValueprivate final BooleanisRequired
-
Constructor Summary
Constructors Constructor Description PluginOption(String name, String description, PluginOptionType type, String defaultValue, Boolean isRequired)
-
Method Summary
Modifier and Type Method Description final StringgetName()The name of the option. final StringgetDescription()The description of the option. final PluginOptionTypegetType()The type of the option. final StringgetDefaultValue()The default value of the option, or nullif the option is required.final BooleanisRequired()Whether the option is required. -
-
Constructor Detail
-
PluginOption
PluginOption(String name, String description, PluginOptionType type, String defaultValue, Boolean isRequired)
-
-
Method Detail
-
getName
final String getName()
The name of the option. Must be unique among all options of the same plugin.
-
getDescription
final String getDescription()
The description of the option.
-
getType
final PluginOptionType getType()
The type of the option.
-
getDefaultValue
final String getDefaultValue()
The default value of the option, or
nullif the option is required.
-
isRequired
final Boolean isRequired()
Whether the option is required.
-
-
-
-