APIdia Launch Partner
Top Description Inners Constructors Methods
jdk.tools.jlink.internal

public final Class Jlink

extends Object
Class Inheritance
Imports
java.lang.module.Configuration, .ModuleFinder, java.nio.file.Path, java.util.ArrayList, .Collections, .List, .Map, .Objects, .Set, jdk.tools.jlink.builder.ImageBuilder, jdk.tools.jlink.plugin.Plugin, .PluginException
API to call jlink.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Jlink.JlinkConfiguration

Jlink configuration.

public static class
Jlink.PluginsConfiguration

A complete plugin configuration.

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
private Jlink.PluginsConfiguration
addAutoEnabledPlugins(Jlink.PluginsConfiguration pluginsConfig)

public void
build(Jlink.JlinkConfiguration
Jlink config, must not be null.
config)

Build the image.

public void
build(Jlink.JlinkConfiguration
Jlink config, must not be null.
config, Jlink.PluginsConfiguration
Plugins config, can be null
pluginsConfig)

Build the image with a plugin configuration.

public static Plugin

Returns:

A new plugin or null if plugin is unknown.
newPlugin(String
Plugin name
name, Map<String, String>
Plugin configuration.
configuration, ModuleLayer
Plugins Layer. null means boot layer.
pluginsLayer)

Create a plugin.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Jlinkback to summary
public Jlink()

Method Detail

addAutoEnabledPluginsback to summary
private Jlink.PluginsConfiguration addAutoEnabledPlugins(Jlink.PluginsConfiguration pluginsConfig)
buildback to summary
public void build(Jlink.JlinkConfiguration config)

Build the image.

Parameters
config:Jlink.JlinkConfiguration

Jlink config, must not be null.

buildback to summary
public void build(Jlink.JlinkConfiguration config, Jlink.PluginsConfiguration pluginsConfig)

Build the image with a plugin configuration.

Parameters
config:Jlink.JlinkConfiguration

Jlink config, must not be null.

pluginsConfig:Jlink.PluginsConfiguration

Plugins config, can be null

newPluginback to summary
public static Plugin newPlugin(String name, Map<String, String> configuration, ModuleLayer pluginsLayer)

Create a plugin.

Parameters
name:String

Plugin name

configuration:Map<String, String>

Plugin configuration.

pluginsLayer:ModuleLayer

Plugins Layer. null means boot layer.

Returns:Plugin

A new plugin or null if plugin is unknown.

jdk.tools.jlink.internal back to summary

public final Class Jlink.JlinkConfiguration

extends Object
Class Inheritance
Jlink configuration. Instances of this class are used to configure jlink.

Field Summary

Modifier and TypeField and Description
private final ModuleFinder
finder

private final boolean
generateRuntimeImage

private final boolean
ignoreModifiedRuntime

private final boolean
linkFromRuntimeImage

private final Set<String>
modules

private final Path
output

Constructor Summary

AccessConstructor and Description
public
JlinkConfiguration(Path
Output directory, must not exist.
output, Set<String>
The possibly-empty set of root modules to resolve
modules, ModuleFinder
the ModuleFinder for this configuration
finder, boolean linkFromRuntimeImage, boolean ignoreModifiedRuntime, boolean generateRuntimeImage)

jlink configuration,

Method Summary

Modifier and TypeMethod and Description
public ModuleFinder
finder()

Returns ModuleFinder that finds all observable modules for this jlink configuration.

public Set<String>
getModules()

Returns: the modules

public Path
getOutput()

Returns: the output

public boolean
ignoreModifiedRuntime()

public boolean
isGenerateRuntimeImage()

public boolean
linkFromRuntimeImage()

public Configuration
resolve()

Returns a Configuration of the given module path, root modules with no service binding.

public Configuration
resolveAndBind()

Returns a Configuration of the given module path, root modules with full service binding.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

finderback to summary
private final ModuleFinder finder
generateRuntimeImageback to summary
private final boolean generateRuntimeImage
ignoreModifiedRuntimeback to summary
private final boolean ignoreModifiedRuntime
linkFromRuntimeImageback to summary
private final boolean linkFromRuntimeImage
modulesback to summary
private final Set<String> modules
outputback to summary
private final Path output

Constructor Detail

JlinkConfigurationback to summary
public JlinkConfiguration(Path output, Set<String> modules, ModuleFinder finder, boolean linkFromRuntimeImage, boolean ignoreModifiedRuntime, boolean generateRuntimeImage)

jlink configuration,

Parameters
output:Path

Output directory, must not exist.

modules:Set<String>

The possibly-empty set of root modules to resolve

finder:ModuleFinder

the ModuleFinder for this configuration

Method Detail

finderback to summary
public ModuleFinder finder()

Returns ModuleFinder that finds all observable modules for this jlink configuration.

getModulesback to summary
public Set<String> getModules()
Returns:Set<String>

the modules

getOutputback to summary
public Path getOutput()
Returns:Path

the output

ignoreModifiedRuntimeback to summary
public boolean ignoreModifiedRuntime()
isGenerateRuntimeImageback to summary
public boolean isGenerateRuntimeImage()
linkFromRuntimeImageback to summary
public boolean linkFromRuntimeImage()
resolveback to summary
public Configuration resolve()

Returns a Configuration of the given module path, root modules with no service binding.

resolveAndBindback to summary
public Configuration resolveAndBind()

Returns a Configuration of the given module path, root modules with full service binding.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
jdk.tools.jlink.internal back to summary

public final Class Jlink.PluginsConfiguration

extends Object
Class Inheritance
A complete plugin configuration. Instances of this class are used to configure jlink.

Field Summary

Modifier and TypeField and Description
private final ImageBuilder
imageBuilder

private final String
lastSorterPluginName

private final List<Plugin>
plugins

Constructor Summary

AccessConstructor and Description
public
PluginsConfiguration()

Empty plugins configuration.

public
PluginsConfiguration(List<Plugin>
List of plugins.
plugins)

Plugins configuration.

public
PluginsConfiguration(List<Plugin>
List of transformer plugins.
plugins, ImageBuilder
Image builder.
imageBuilder, String
Name of last sorter plugin, no sorting can occur after it.
lastSorterPluginName)

Plugins configuration with a last sorter and an ImageBuilder.

Method Summary

Modifier and TypeMethod and Description
public ImageBuilder
getImageBuilder()

Returns: the imageBuilder

public String
getLastSorterPluginName()

Returns: the lastSorterPluginName

public List<Plugin>
getPlugins()

Returns: the plugins

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

imageBuilderback to summary
private final ImageBuilder imageBuilder
lastSorterPluginNameback to summary
private final String lastSorterPluginName
pluginsback to summary
private final List<Plugin> plugins

Constructor Detail

PluginsConfigurationback to summary
public PluginsConfiguration()

Empty plugins configuration.

PluginsConfigurationback to summary
public PluginsConfiguration(List<Plugin> plugins)

Plugins configuration.

Parameters
plugins:List<Plugin>

List of plugins.

PluginsConfigurationback to summary
public PluginsConfiguration(List<Plugin> plugins, ImageBuilder imageBuilder, String lastSorterPluginName)

Plugins configuration with a last sorter and an ImageBuilder. No sorting can occur after the last sorter plugin. The ImageBuilder is in charge to layout the image content on disk.

Parameters
plugins:List<Plugin>

List of transformer plugins.

imageBuilder:ImageBuilder

Image builder.

lastSorterPluginName:String

Name of last sorter plugin, no sorting can occur after it.

Method Detail

getImageBuilderback to summary
public ImageBuilder getImageBuilder()
Returns:ImageBuilder

the imageBuilder

getLastSorterPluginNameback to summary
public String getLastSorterPluginName()
Returns:String

the lastSorterPluginName

getPluginsback to summary
public List<Plugin> getPlugins()
Returns:List<Plugin>

the plugins

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override