public interface Plugin
Modifier and Type | Interface | Description |
---|---|---|
static class |
Plugin.Category |
Order of categories matches the plugin sort order.
|
static class |
Plugin.State |
Plugin state:
DISABLED: The plugin is not exposed in help and will be not called.
AUTO_ENABLED: The plugin is enabled by default.
|
Modifier and Type | Method | Description |
---|---|---|
default void |
configure(Map<String,String> config) |
Configure the plugin based on the passed configuration.
|
default String |
getArgumentsDescription() |
The plugin argument(s) description.
|
default String |
getDescription() |
The plugin description.
|
default String |
getName() |
The plugin name.
|
default String |
getOption() |
The option that identifies this plugin.
|
default Set<Plugin.State> |
getState() |
The Plugin set of states.
|
default String |
getStateDescription() |
Return a message indicating the status of the provider.
|
default Plugin.Category |
getType() |
The type of this plugin.
|
default boolean |
hasArguments() |
Has this plugin require one or more arguments?
|
ResourcePool |
transform(ResourcePool in,
ResourcePoolBuilder out) |
Visit the content of the modules that are composing the image.
|
default Plugin.Category getType()
default Set<Plugin.State> getState()
default String getName()
default String getDescription()
default String getOption()
default boolean hasArguments()
--plugin-option=arg_valueIf there are more than arguments, command line option looks like:
--plugin-option=arg_value:arg2=value2:arg3=value3...
default String getArgumentsDescription()
default String getStateDescription()
default void configure(Map<String,String> config)
config
- The plugin configuration.IllegalArgumentException
- if a mandatory argument is missing or
if an argument has invalid value.ResourcePool transform(ResourcePool in, ResourcePoolBuilder out)
in
- Read only content.out
- The pool to fill with content. This pool must contain
the result of the visit.PluginException
Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 2015, 2016, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-Ubuntu+0-9b149-1