OpenJDK 1.22 · jdk.jpackage.internal.AppImageBundler

Modifier and Type	Class and Description
pack-priv static interface	AppImageBundler.ParamsValidator

Modifier and Type	Field and Description
private Function<Path, AbstractAppImageBuilder>	appImageSupplier
private boolean	dependentTask
private AppImageBundler.ParamsValidator	paramsValidator

Access	Constructor and Description
pack-priv	AppImageBundler()

Method Summary

Modifier and Type	Method and Description
private Path	createAppBundle(Map<String, ? super Object> params, Path outputDirectory)
private Path	createRoot(Map<String, ? super Object> params, Path outputDirectory)
public final Path	execute(Map<String, ? super Object> The Bundle parameters, Keyed by the id from the ParamInfo. Execution may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy. params, Path The parent dir that the returned bundle will be placed in. outputParentDir) Implements jdk.jpackage.internal.Bundler.execute. Creates a bundle from existing content.
public final String	getBundleType() Implements jdk.jpackage.internal.Bundler.getBundleType.
public final String	getID() Implements jdk.jpackage.internal.Bundler.getID.
public final String	getName() Implements jdk.jpackage.internal.Bundler.getName.
public final boolean	isDefault() Implements jdk.jpackage.internal.Bundler.isDefault. Returns "true" if this bundler is he default for the current platform.
pack-priv final boolean	isDependentTask()
pack-priv final AppImageBundler	setAppImageSupplier(Function<Path, AbstractAppImageBuilder> v)
pack-priv final AppImageBundler	setDependentTask(boolean v)
pack-priv final AppImageBundler	setParamsValidator(AppImageBundler.ParamsValidator v)
public final boolean	supported(boolean runtimeInstaller) Implements jdk.jpackage.internal.Bundler.supported. Returns "true" if this bundler is supported on current platform.
public final boolean	validate(Map<String, ? super Object> The parameters to be validate. Validation may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy. params) Implements jdk.jpackage.internal.Bundler.validate. Determines if this bundler will execute with the given parameters.

Inherited from jdk.jpackage.internal.AbstractBundler:: cleanup toString

appImageSupplier	back to summary
private Function<Path, AbstractAppImageBuilder> appImageSupplier

dependentTask	back to summary
private boolean dependentTask

paramsValidator	back to summary
private AppImageBundler.ParamsValidator paramsValidator

AppImageBundler	back to summary
pack-priv AppImageBundler()

Method Detail

createAppBundle	back to summary
private Path createAppBundle(Map<String, ? super Object> params, Path outputDirectory) throws PackagerException, IOException, ConfigException

createRoot	back to summary
private Path createRoot(Map<String, ? super Object> params, Path outputDirectory) throws PackagerException, IOException

execute back to summary

execute	back to summary
public final Path execute(Map<String, ? super Object> params, Path outputParentDir) throws PackagerException Implements jdk.jpackage.internal.Bundler.execute. Doc from jdk.jpackage.internal.Bundler.execute. Creates a bundle from existing content. If a call to `validate(java.util.Map)` date} returns true with the parameters map, then you can expect a valid output. However if an exception was thrown out of validate or it returned false then you should not expect sensible results from this call. It may or may not return a value, and it may or may not throw an exception. But any output should not be considered valid or sane. Parameters params:Map<String, ? super Object> The Bundle parameters, Keyed by the id from the ParamInfo. Execution may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy. outputParentDir:Path The parent dir that the returned bundle will be placed in. Returns:Path The resulting bundled file For a bundler that produces a single artifact file this will be the location of that artifact (.exe file, .deb file, etc) For a bundler that produces a specific directory format output this will be the location of that specific directory (.app file, etc). For a bundler that produce multiple files, this will be a parent directory of those files (linux and windows images), whose name is not relevant to the result. Annotations @Override

public final Path execute(Map<String, ? super Object> params, Path outputParentDir) throws PackagerException

Implements jdk.jpackage.internal.Bundler.execute.

Doc from jdk.jpackage.internal.Bundler.execute.

Creates a bundle from existing content. If a call to validate(java.util.Map) date} returns true with the parameters map, then you can expect a valid output. However if an exception was thrown out of validate or it returned false then you should not expect sensible results from this call. It may or may not return a value, and it may or may not throw an exception. But any output should not be considered valid or sane.

Parameters

params:Map<String, ? super Object>: The Bundle parameters, Keyed by the id from the ParamInfo. Execution may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy.
outputParentDir:Path: The parent dir that the returned bundle will be placed in.

Returns:Path

The resulting bundled file For a bundler that produces a single artifact file this will be the location of that artifact (.exe file, .deb file, etc) For a bundler that produces a specific directory format output this will be the location of that specific directory (.app file, etc). For a bundler that produce multiple files, this will be a parent directory of those files (linux and windows images), whose name is not relevant to the result.

Annotations

@Override

getBundleType	back to summary
public final String getBundleType() Implements jdk.jpackage.internal.Bundler.getBundleType. Returns:String Doc from jdk.jpackage.internal.Bundler.getBundleType. The bundle type of the bundle that is created by this bundler. Annotations @Override

getBundleType

back to summary

public final String getBundleType()

Implements jdk.jpackage.internal.Bundler.getBundleType.

Returns:String

Doc from jdk.jpackage.internal.Bundler.getBundleType.

The bundle type of the bundle that is created by this bundler.

Annotations

@Override

getID	back to summary
public final String getID() Implements jdk.jpackage.internal.Bundler.getID. Returns:String Doc from jdk.jpackage.internal.Bundler.getID. Command line identifier of the bundler. Should be unique. Annotations @Override

getID

back to summary

public final String getID()

Implements jdk.jpackage.internal.Bundler.getID.

Returns:String

Doc from jdk.jpackage.internal.Bundler.getID.

Command line identifier of the bundler. Should be unique.

Annotations

@Override

getName	back to summary
public final String getName() Implements jdk.jpackage.internal.Bundler.getName. Returns:String Doc from jdk.jpackage.internal.Bundler.getName. User Friendly name of this bundler. Annotations @Override

getName

back to summary

public final String getName()

Implements jdk.jpackage.internal.Bundler.getName.

Returns:String

Doc from jdk.jpackage.internal.Bundler.getName.

User Friendly name of this bundler.

Annotations

@Override

isDefault	back to summary
public final boolean isDefault() Implements jdk.jpackage.internal.Bundler.isDefault. Doc from jdk.jpackage.internal.Bundler.isDefault. Returns "true" if this bundler is he default for the current platform. Annotations @Override

isDefault

back to summary

public final boolean isDefault()

Implements jdk.jpackage.internal.Bundler.isDefault.

Doc from jdk.jpackage.internal.Bundler.isDefault.

Returns "true" if this bundler is he default for the current platform.

Annotations

@Override

isDependentTask	back to summary
pack-priv final boolean isDependentTask()

setAppImageSupplier	back to summary
pack-priv final AppImageBundler setAppImageSupplier(Function<Path, AbstractAppImageBuilder> v)

setDependentTask	back to summary
pack-priv final AppImageBundler setDependentTask(boolean v)

setParamsValidator	back to summary
pack-priv final AppImageBundler setParamsValidator(AppImageBundler.ParamsValidator v)

supported	back to summary
public final boolean supported(boolean runtimeInstaller) Implements jdk.jpackage.internal.Bundler.supported. Doc from jdk.jpackage.internal.Bundler.supported. Returns "true" if this bundler is supported on current platform. Annotations @Override

supported

back to summary

public final boolean supported(boolean runtimeInstaller)

Implements jdk.jpackage.internal.Bundler.supported.

Doc from jdk.jpackage.internal.Bundler.supported.

Returns "true" if this bundler is supported on current platform.

Annotations

@Override

validate	back to summary
public final boolean validate(Map<String, ? super Object> params) throws ConfigException Implements jdk.jpackage.internal.Bundler.validate. Doc from jdk.jpackage.internal.Bundler.validate. Determines if this bundler will execute with the given parameters. Parameters params:Map<String, ? super Object> The parameters to be validate. Validation may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy. Returns:boolean true if valid Annotations @Override Exceptions ConfigException: If the configuration params are incorrect. The exception may contain advice on how to modify the params map to make it valid.

validate

back to summary

public final boolean validate(Map<String, ? super Object> params) throws ConfigException

Implements jdk.jpackage.internal.Bundler.validate.

Doc from jdk.jpackage.internal.Bundler.validate.

Determines if this bundler will execute with the given parameters.

Parameters

params:Map<String, ? super Object>: The parameters to be validate. Validation may modify the map, so if you are going to be using the same map across multiple bundlers you should pass in a deep copy.

Returns:boolean

true if valid

Annotations

@Override

Exceptions

ConfigException:: If the configuration params are incorrect. The exception may contain advice on how to modify the params map to make it valid.

pack-priv Class AppImageBundler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface AppImageBundler.ParamsValidator

Method Summary

Method Detail