Modifier and Type	Class and Description
public static enum	Plugin.Category Order of categories matches the plugin sort order.
public static enum	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. It doesn't require its option to be present to be called. FUNCTIONAL: The plugin is properly configured and can operate. Non functional plugin must advertise their status in the `getStateDescription` method

Method Summary

Modifier and Type	Method and Description
public default void	configure(Map<String, String> The plugin configuration. config) Configure the plugin based on the passed configuration.
public default String	Returns: The argument(s) description. getArgumentsDescription() The plugin argument(s) description.
public default String	Returns: The description. getDescription() The plugin description.
public default String	Returns: The name. getName() The plugin name.
public default String	Returns: The plugin option. getOption() The option that identifies this plugin.
public default Set<Plugin.State>	Returns: The set of states. getState() The Plugin set of states.
public default String	Returns: A status description. getStateDescription() Return a message indicating the status of the provider.
public default Plugin.Category	Returns: The type of this plugin getType() The type of this plugin.
public default String	Returns: The usage. getUsage() The plugin usage for printing to console.
public default boolean	Returns: true if arguments are needed. hasArguments() Has this plugin require one or more arguments?
public default boolean	hasRawArgument()
public ResourcePool	transform(ResourcePool Read only content. in, ResourcePoolBuilder The pool to fill with content. This pool must contain the result of the visit. out) Visit the content of the modules that are composing the image.

Method Detail

configure	back to summary
public default void configure(Map<String, String> config) Configure the plugin based on the passed configuration. This method is called prior to invoke the plugin. Parameters config:Map<String, String> The plugin configuration. Exceptions IllegalArgumentException: if a mandatory argument is missing or if an argument has invalid value.

configure

back to summary

public default void configure(Map<String, String> config)

Configure the plugin based on the passed configuration. This method is called prior to invoke the plugin.

Parameters

config:Map<String, String>: The plugin configuration.

Exceptions

IllegalArgumentException:: if a mandatory argument is missing or if an argument has invalid value.

getArgumentsDescription	back to summary
public default String getArgumentsDescription() The plugin argument(s) description. Returns:String The argument(s) description.

getArgumentsDescription

back to summary

public default String getArgumentsDescription()

The plugin argument(s) description.

Returns:String: The argument(s) description.

getDescription	back to summary
public default String getDescription() The plugin description. Returns:String The description.

getDescription

back to summary

public default String getDescription()

The plugin description.

Returns:String: The description.

getName	back to summary
public default String getName() The plugin name. Returns:String The name.

getName

back to summary

public default String getName()

The plugin name.

Returns:String: The name.

getOption	back to summary
public default String getOption() The option that identifies this plugin. This may be null. "--" is prefixed to the String (when non-null) when invoking this plugin from jlink command line. Returns:String The plugin option.

getOption

back to summary

public default String getOption()

The option that identifies this plugin. This may be null. "--" is prefixed to the String (when non-null) when invoking this plugin from jlink command line.

Returns:String: The plugin option.

getState	back to summary
public default Set<Plugin.State> getState() The Plugin set of states. Returns:Set<Plugin.State> The set of states.

getState

back to summary

public default Set<Plugin.State> getState()

The Plugin set of states.

Returns:Set<Plugin.State>: The set of states.

getStateDescription	back to summary
public default String getStateDescription() Return a message indicating the status of the provider. Returns:String A status description.

getStateDescription

back to summary

public default String getStateDescription()

Return a message indicating the status of the provider.

Returns:String: A status description.

getType	back to summary
public default Plugin.Category getType() The type of this plugin. Returns:Plugin.Category The type of this plugin

getType

back to summary

public default Plugin.Category getType()

The type of this plugin.

Returns:Plugin.Category: The type of this plugin

getUsage	back to summary
public default String getUsage() The plugin usage for printing to console. Returns:String The usage.

getUsage

back to summary

public default String getUsage()

The plugin usage for printing to console.

Returns:String: The usage.

hasArguments	back to summary
public default boolean hasArguments() Has this plugin require one or more arguments? A plugin can have one or more optional arguments. A plugin option with a single argument is specified as follows: --plugin-option=arg_value If there are more than arguments, command line option looks like: --plugin-option=arg_value:arg2=value2:arg3=value3... Returns:boolean true if arguments are needed.

hasArguments

back to summary

public default boolean hasArguments()

Has this plugin require one or more arguments? A plugin can have one or more optional arguments.
A plugin option with a single argument is specified as follows:

     --plugin-option=arg_value

If there are more than arguments, command line option looks like:

     --plugin-option=arg_value:arg2=value2:arg3=value3...

Returns:boolean: true if arguments are needed.

hasRawArgument	back to summary
public default boolean hasRawArgument()

transform	back to summary
public ResourcePool transform(ResourcePool in, ResourcePoolBuilder out) Visit the content of the modules that are composing the image. Parameters in:ResourcePool Read only content. out:ResourcePoolBuilder The pool to fill with content. This pool must contain the result of the visit.

transform

back to summary

public ResourcePool transform(ResourcePool in, ResourcePoolBuilder out)

Visit the content of the modules that are composing the image.

Parameters

in:ResourcePool: Read only content.
out:ResourcePoolBuilder: The pool to fill with content. This pool must contain the result of the visit.

jdk.tools.jlink.plugin back to summary

public final Enum Plugin.Category

Class Inheritance

extends Enum<Plugin.Category>

java.lang.Object
java.lang.Enum
jdk.tools.jlink.plugin.Plugin.Category

Order of categories matches the plugin sort order.

FILTER: Filter in/out resources or files.
ADDER: Add resources or files.
TRANSFORMER: Transform resources or files(eg: refactoring, bytecode manipulation).
MODULEINFO_TRANSFORMER: Transform only module-info.class
SORTER: Sort resources within the resource container.
METAINFO_ADDER: Added meta info (like release, copyright etc.)
COMPRESSOR: Compress resource within the resource containers.
VERIFIER: Does some image verification.
PROCESSOR: Does some post processing on image.
PACKAGER: Final processing

Field Summary

Modifier and Type	Field and Description
public static final Plugin.Category	ADDER
public static final Plugin.Category	COMPRESSOR
public static final Plugin.Category	FILTER
public static final Plugin.Category	METAINFO_ADDER
public static final Plugin.Category	MODULEINFO_TRANSFORMER
private final String	name Hides java.lang.Enum.name.
public static final Plugin.Category	PACKAGER
public static final Plugin.Category	PROCESSOR
public static final Plugin.Category	SORTER
public static final Plugin.Category	TRANSFORMER
public static final Plugin.Category	VERIFIER

Constructor Summary

Access	Constructor and Description
private	Category(String name)

Method Summary

Modifier and Type	Method and Description
public String	getName()
public static Plugin.Category	valueOf(String name)
public static Plugin.Category[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ADDER	back to summary
public static final Plugin.Category ADDER

COMPRESSOR	back to summary
public static final Plugin.Category COMPRESSOR

FILTER	back to summary
public static final Plugin.Category FILTER

METAINFO_ADDER	back to summary
public static final Plugin.Category METAINFO_ADDER

MODULEINFO_TRANSFORMER	back to summary
public static final Plugin.Category MODULEINFO_TRANSFORMER

name	back to summary
private final String name Hides java.lang.Enum.name.

PACKAGER	back to summary
public static final Plugin.Category PACKAGER

PROCESSOR	back to summary
public static final Plugin.Category PROCESSOR

SORTER	back to summary
public static final Plugin.Category SORTER

TRANSFORMER	back to summary
public static final Plugin.Category TRANSFORMER

VERIFIER	back to summary
public static final Plugin.Category VERIFIER

Constructor Detail

Category	back to summary
private Category(String name)

Method Detail

getName	back to summary
public String getName()

valueOf	back to summary
public static Plugin.Category valueOf(String name)

values	back to summary
public static Plugin.Category[] values()

jdk.tools.jlink.plugin back to summary

public final Enum Plugin.State

Class Inheritance

extends Enum<Plugin.State>

java.lang.Object
java.lang.Enum
jdk.tools.jlink.plugin.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. It doesn't require its option to be present to be called.
FUNCTIONAL: The plugin is properly configured and can operate. Non functional plugin must advertise their status in the getStateDescription method

Field Summary

Modifier and Type	Field and Description
public static final Plugin.State	AUTO_ENABLED
public static final Plugin.State	DISABLED
public static final Plugin.State	FUNCTIONAL

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static Plugin.State	valueOf(String name)
public static Plugin.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

AUTO_ENABLED	back to summary
public static final Plugin.State AUTO_ENABLED

DISABLED	back to summary
public static final Plugin.State DISABLED

FUNCTIONAL	back to summary
public static final Plugin.State FUNCTIONAL

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static Plugin.State valueOf(String name)

values	back to summary
public static Plugin.State[] values()

public Interface Plugin

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum Plugin.Category

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Plugin.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail