Package org.ossreviewtoolkit.plugins.api
Class PluginDescriptor
-
- All Implemented Interfaces:
public final class PluginDescriptorA descriptor holding the metadata of a plugin.
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringidprivate final StringdisplayNameprivate final Stringdescriptionprivate final List<PluginOption>options
-
Constructor Summary
Constructors Constructor Description PluginDescriptor(String id, String displayName, String description, List<PluginOption> options)
-
Method Summary
Modifier and Type Method Description final StringgetId()The id of the plugin class. final StringgetDisplayName()The display name of the plugin. final StringgetDescription()The description of the plugin. final List<PluginOption>getOptions()The configuration options supported by the plugin. -
-
Constructor Detail
-
PluginDescriptor
PluginDescriptor(String id, String displayName, String description, List<PluginOption> options)
-
-
Method Detail
-
getId
final String getId()
The id of the plugin class. Must be unique among all plugins for the same factory class.
-
getDisplayName
final String getDisplayName()
The display name of the plugin.
-
getDescription
final String getDescription()
The description of the plugin.
-
getOptions
final List<PluginOption> getOptions()
The configuration options supported by the plugin.
-
-
-
-