APIdia Launch Partner
Top Description Inners Fields Constructors Methods
jdk.jpackage.internal.cli

public final Class StandardOption

extends Object
Class Inheritance
Static Imports
java.util.stream.Collectors.toUnmodifiableSet, jdk.jpackage.internal.cli.OptionSpecBuilder.pathSeparator, .OptionSpecBuilder.toList, .StandardBundlingOperation.CREATE_MAC_PKG, .StandardBundlingOperation.CREATE_NATIVE, .StandardBundlingOperation.SIGN_MAC_APP_IMAGE, .StandardBundlingOperation.fromOptionName, .StandardOptionContext.createOptionSpecBuilderMutator, .StandardOptionValueExceptionFactory.ERROR_WITH_VALUE, .StandardOptionValueExceptionFactory.ERROR_WITH_VALUE_AND_OPTION_NAME, .StandardOptionValueExceptionFactory.forMessageWithOptionValueAndName, .StandardValueConverter.addLauncherShortcutConv, .StandardValueConverter.booleanConv, .StandardValueConverter.explodedPathConverter, .StandardValueConverter.identityConv, .StandardValueConverter.mainLauncherShortcutConv, .StandardValueConverter.pathConv, .StandardValueConverter.uuidConv

jpackage command line options

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
pack-priv static class
pack-priv static class
private static class
private static class
pack-priv static enum
StandardOption.LauncherProperty

Scope of options configuring a launcher.

Field Summary

Modifier and TypeField and Description
public static final OptionValue<String>
pack-priv static final OptionValue<AdditionalLauncher[]>
public static final OptionValue<List<String>>
public static final OptionValue<List<Options>>
ADDITIONAL_LAUNCHERS

Processed additional launcher property files.

public static final OptionValue<List<Collection<RootedPath>>>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<List<String>>
public static final OptionValue<BundlingOperationDescriptor>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<Path>
public static final OptionValue<Boolean>
EXIT_AFTER_CONFIGURATION_PHASE

Debug option telling bundler to exit after the configuration phase is over, without running the packaging phase.

public static final OptionValue<List<Options>>
FILE_ASSOCIATIONS

Processed file association property files.

pack-priv static final OptionValue<Path[]>
pack-priv static final OptionValue<Boolean>
public static final OptionValue<Path>
public static final OptionValue<? extends Collection<RootedPath>>
public static final OptionValue<Path>
public static final OptionValue<List<String>>
public static final OptionValue<Boolean>
public static final OptionValue<Path>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<LauncherShortcut>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<Boolean>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<String>
public static final OptionValue<List<Collection<RootedPath>>>
public static final OptionValue<Path>
public static final OptionValue<String>
public static final OptionValue<Boolean>
private static final Set<OptionScope>
public static final OptionValue<String>
public static final OptionValue<Path>
public static final OptionValue<Path>
public static final OptionValue<String>
public static final OptionValue<List<Path>>
public static final OptionValue<String>
private static final Set<BundlingOperationModifier>
NOT_BUILDING_APP_IMAGE

Modes in which bundling operations don't involve building of an app image.

public static final OptionValue<Path>
public static final OptionValue<Path>
public static final OptionValue<Path>
pack-priv static final OptionSpec<Path>
public static final OptionValue<Path>
private static final Set<OperatingSystem>
public static final OptionValue<Path>
pack-priv static final OptionValue<BundleType>
public static final OptionValue<String>
pack-priv static final OptionValue<LogEnvironment.Builder>
pack-priv static final OptionValue<Boolean>
public static final OptionValue<Boolean>
public static final OptionValue<String>
public static final OptionValue<Boolean>
public static final OptionValue<String>
public static final OptionValue<LauncherShortcut>
public static final OptionValue<Boolean>
public static final OptionValue<LauncherShortcut>
public static final OptionValue<Boolean>
public static final OptionValue<String>
public static final OptionValue<UUID>
public static final OptionValue<Boolean>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
private static OptionSpecBuilder<Boolean>
private static OptionSpecBuilder<Boolean>
pack-priv static Consumer<OptionSpecBuilder<Boolean>>
private static OptionValue<AdditionalLauncher[]>
private static Validator<Path, RuntimeException>
private static OptionSpecBuilder<Path>
pack-priv static Consumer<OptionSpecBuilder<Path>>
private static OptionSpecBuilder<String>
private static OptionSpecBuilder<Path>
pack-priv static Consumer<OptionSpecBuilder<Path>>
pack-priv static Function<OptionSpecBuilder<Path>, OptionSpecBuilder<RootedPath[]>>
private static OptionSpecBuilder<Path>
pack-priv static Consumer<OptionSpecBuilder<Path>>
pack-priv static Set<Option>

Returns:

the options configuring a launcher
launcherOptions
()

Returns options configuring a launcher.

private static OptionSpecBuilder<LauncherShortcut>
pack-priv static Consumer<OptionSpecBuilder<LauncherShortcut>>
private static UnaryOperator<Set<OptionScope>>
private static <T> OptionSpecBuilder<T>
option(String name, Class<? extends T> valueType)

pack-priv static Set<Option>

Returns:

public and package-private options defined in StandardOption class
options
()

Returns public and package-private options with option specs defined in StandardOption class.

private static BundleType
private static OptionSpecBuilder<Path>
pack-priv static Consumer<OptionSpecBuilder<Path>>
pack-priv static Predicate<OptionSpec<?>>

Returns:

the predicate
platformOption
(OperatingSystem
the platform
os
)

Returns a Predicate that returns true if the given option spec denotes an option supported on the given platform.

private static String
pack-priv static Predicate<OptionSpec<?>>

Returns:

the predicate
sharedOption
()

Returns a Predicate that returns true if the given option spec denotes an option supported on all platforms.

private static OptionSpecBuilder<String>
pack-priv static Consumer<OptionSpecBuilder<String>>
private static <T> Function<OptionValue.Builder<RootedPath[][]>, OptionValue<List<Collection<RootedPath>>>>
private static OptionSpecBuilder<String>
private static OptionSpecBuilder<UUID>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ABOUT_URLback to summary
public static final OptionValue<String> ABOUT_URL
ADD_LAUNCHER_INTERNALback to summary
pack-priv static final OptionValue<AdditionalLauncher[]> ADD_LAUNCHER_INTERNAL
ADD_MODULESback to summary
public static final OptionValue<List<String>> ADD_MODULES
ADDITIONAL_LAUNCHERSback to summary
public static final OptionValue<List<Options>> ADDITIONAL_LAUNCHERS

Processed additional launcher property files.

Items in the list are in the order "--add-launcher" options appeared on the command line. Every item in the list has SOURCE_PROPERY_FILE option with the value set to the source property file and NAME option with the value set to the additional launcher name.

APP_CONTENTback to summary
public static final OptionValue<List<Collection<RootedPath>>> APP_CONTENT
APP_VERSIONback to summary
public static final OptionValue<String> APP_VERSION
APPCLASSback to summary
public static final OptionValue<String> APPCLASS
ARGUMENTSback to summary
public static final OptionValue<List<String>> ARGUMENTS
BUNDLING_OPERATION_DESCRIPTORback to summary
public static final OptionValue<BundlingOperationDescriptor> BUNDLING_OPERATION_DESCRIPTOR
DESCRIPTIONback to summary
public static final OptionValue<String> DESCRIPTION
DESTback to summary
public static final OptionValue<Path> DEST
EXIT_AFTER_CONFIGURATION_PHASEback to summary
public static final OptionValue<Boolean> EXIT_AFTER_CONFIGURATION_PHASE

Debug option telling bundler to exit after the configuration phase is over, without running the packaging phase.

FILE_ASSOCIATIONSback to summary
public static final OptionValue<List<Options>> FILE_ASSOCIATIONS

Processed file association property files.

Items in the list are in the order "--file-associations" options appeared on the command line. Every item in the list has SOURCE_PROPERY_FILE option with the value set to the source property file.

FILE_ASSOCIATIONS_INTERNALback to summary
pack-priv static final OptionValue<Path[]> FILE_ASSOCIATIONS_INTERNAL
HELPback to summary
pack-priv static final OptionValue<Boolean> HELP
ICONback to summary
public static final OptionValue<Path> ICON
INPUTback to summary
public static final OptionValue<? extends Collection<RootedPath>> INPUT
INSTALL_DIRback to summary
public static final OptionValue<Path> INSTALL_DIR
JAVA_OPTIONSback to summary
public static final OptionValue<List<String>> JAVA_OPTIONS
LAUNCHER_AS_SERVICEback to summary
public static final OptionValue<Boolean> LAUNCHER_AS_SERVICE
LICENSE_FILEback to summary
public static final OptionValue<Path> LICENSE_FILE
LINUX_APP_CATEGORYback to summary
public static final OptionValue<String> LINUX_APP_CATEGORY
LINUX_DEB_MAINTAINER_EMAILback to summary
public static final OptionValue<String> LINUX_DEB_MAINTAINER_EMAIL
LINUX_MENU_GROUPback to summary
public static final OptionValue<String> LINUX_MENU_GROUP
LINUX_PACKAGE_DEPENDENCIESback to summary
public static final OptionValue<String> LINUX_PACKAGE_DEPENDENCIES
LINUX_PACKAGE_NAMEback to summary
public static final OptionValue<String> LINUX_PACKAGE_NAME
LINUX_RELEASEback to summary
public static final OptionValue<String> LINUX_RELEASE
LINUX_RPM_LICENSE_TYPEback to summary
public static final OptionValue<String> LINUX_RPM_LICENSE_TYPE
LINUX_SHORTCUT_HINTback to summary
public static final OptionValue<LauncherShortcut> LINUX_SHORTCUT_HINT
MAC_APP_CATEGORYback to summary
public static final OptionValue<String> MAC_APP_CATEGORY
MAC_APP_IMAGE_SIGN_IDENTITYback to summary
public static final OptionValue<String> MAC_APP_IMAGE_SIGN_IDENTITY
MAC_APP_STOREback to summary
public static final OptionValue<Boolean> MAC_APP_STORE
MAC_BUNDLE_IDENTIFIERback to summary
public static final OptionValue<String> MAC_BUNDLE_IDENTIFIER
MAC_BUNDLE_NAMEback to summary
public static final OptionValue<String> MAC_BUNDLE_NAME
MAC_BUNDLE_SIGNING_PREFIXback to summary
public static final OptionValue<String> MAC_BUNDLE_SIGNING_PREFIX
MAC_DMG_CONTENTback to summary
public static final OptionValue<List<Collection<RootedPath>>> MAC_DMG_CONTENT
MAC_ENTITLEMENTSback to summary
public static final OptionValue<Path> MAC_ENTITLEMENTS
MAC_INSTALLER_SIGN_IDENTITYback to summary
public static final OptionValue<String> MAC_INSTALLER_SIGN_IDENTITY
MAC_SIGNback to summary
public static final OptionValue<Boolean> MAC_SIGN
MAC_SIGNINGback to summary
private static final Set<OptionScope> MAC_SIGNING
MAC_SIGNING_KEY_NAMEback to summary
public static final OptionValue<String> MAC_SIGNING_KEY_NAME
MAC_SIGNING_KEYCHAINback to summary
public static final OptionValue<Path> MAC_SIGNING_KEYCHAIN
MAIN_JARback to summary
public static final OptionValue<Path> MAIN_JAR
MODULEback to summary
public static final OptionValue<String> MODULE
MODULE_PATHback to summary
public static final OptionValue<List<Path>> MODULE_PATH
NAMEback to summary
public static final OptionValue<String> NAME
NOT_BUILDING_APP_IMAGEback to summary
private static final Set<BundlingOperationModifier> NOT_BUILDING_APP_IMAGE

Modes in which bundling operations don't involve building of an app image.

PREDEFINED_APP_IMAGEback to summary
public static final OptionValue<Path> PREDEFINED_APP_IMAGE
PREDEFINED_RUNTIME_IMAGEback to summary
public static final OptionValue<Path> PREDEFINED_RUNTIME_IMAGE
RESOURCE_DIRback to summary
public static final OptionValue<Path> RESOURCE_DIR
RUNTIME_INSTALLER_RUNTIME_IMAGEback to summary
pack-priv static final OptionSpec<Path> RUNTIME_INSTALLER_RUNTIME_IMAGE
SOURCE_PROPERY_FILEback to summary
public static final OptionValue<Path> SOURCE_PROPERY_FILE
SUPPORTED_OSback to summary
private static final Set<OperatingSystem> SUPPORTED_OS
TEMP_ROOTback to summary
public static final OptionValue<Path> TEMP_ROOT
TYPEback to summary
pack-priv static final OptionValue<BundleType> TYPE
VENDORback to summary
public static final OptionValue<String> VENDOR
VERBOSEback to summary
pack-priv static final OptionValue<LogEnvironment.Builder> VERBOSE
VERSIONback to summary
pack-priv static final OptionValue<Boolean> VERSION
WIN_CONSOLE_HINTback to summary
public static final OptionValue<Boolean> WIN_CONSOLE_HINT
WIN_HELP_URLback to summary
public static final OptionValue<String> WIN_HELP_URL
WIN_INSTALLDIR_CHOOSERback to summary
public static final OptionValue<Boolean> WIN_INSTALLDIR_CHOOSER
WIN_MENU_GROUPback to summary
public static final OptionValue<String> WIN_MENU_GROUP
WIN_MENU_HINTback to summary
public static final OptionValue<LauncherShortcut> WIN_MENU_HINT
WIN_PER_USER_INSTALLATIONback to summary
public static final OptionValue<Boolean> WIN_PER_USER_INSTALLATION
WIN_SHORTCUT_HINTback to summary
public static final OptionValue<LauncherShortcut> WIN_SHORTCUT_HINT
WIN_SHORTCUT_PROMPTback to summary
public static final OptionValue<Boolean> WIN_SHORTCUT_PROMPT
WIN_UPDATE_URLback to summary
public static final OptionValue<String> WIN_UPDATE_URL
WIN_UPGRADE_UUIDback to summary
public static final OptionValue<UUID> WIN_UPGRADE_UUID
WIN_WITH_UIback to summary
public static final OptionValue<Boolean> WIN_WITH_UI

Constructor Detail

StandardOptionback to summary
private StandardOption()

Method Detail

auxilaryOptionback to summary
private static OptionSpecBuilder<Boolean> auxilaryOption(String name)
booleanOptionback to summary
private static OptionSpecBuilder<Boolean> booleanOption(String name)
booleanOptionMutatorback to summary
pack-priv static Consumer<OptionSpecBuilder<Boolean>> booleanOptionMutator()
createAddLauncherOptionback to summary
private static OptionValue<AdditionalLauncher[]> createAddLauncherOption(String name)
createExistingPathValidatorback to summary
private static Validator<Path, RuntimeException> createExistingPathValidator(Validator.Builder<Path, RuntimeException> builder, boolean cmdline)
directoryOptionback to summary
private static OptionSpecBuilder<Path> directoryOption(String name)
directoryOptionMutatorback to summary
pack-priv static Consumer<OptionSpecBuilder<Path>> directoryOptionMutator()
escapedStringListOptionback to summary
private static OptionSpecBuilder<String> escapedStringListOption(String name)
existingPathOptionback to summary
private static OptionSpecBuilder<Path> existingPathOption(String name)
existingPathOptionMutatorback to summary
pack-priv static Consumer<OptionSpecBuilder<Path>> existingPathOptionMutator()
explodedPathOptionMapperback to summary
pack-priv static Function<OptionSpecBuilder<Path>, OptionSpecBuilder<RootedPath[]>> explodedPathOptionMapper(ValueConverter<Path, RootedPath[]> conv)
fileOptionback to summary
private static OptionSpecBuilder<Path> fileOption(String name)
fileOptionMutatorback to summary
pack-priv static Consumer<OptionSpecBuilder<Path>> fileOptionMutator()
launcherOptionsback to summary
pack-priv static Set<Option> launcherOptions()

Returns options configuring a launcher.

Returns:Set<Option>

the options configuring a launcher

launcherShortcutOptionback to summary
private static OptionSpecBuilder<LauncherShortcut> launcherShortcutOption(String name)
launcherShortcutOptionMutatorback to summary
pack-priv static Consumer<OptionSpecBuilder<LauncherShortcut>> launcherShortcutOptionMutator()
nativeBundlingback to summary
private static UnaryOperator<Set<OptionScope>> nativeBundling()
optionback to summary
private static <T> OptionSpecBuilder<T> option(String name, Class<? extends T> valueType)
optionsback to summary
pack-priv static Set<Option> options()

Returns public and package-private options with option specs defined in StandardOption class.

Returns:Set<Option>

public and package-private options defined in StandardOption class

parseBundleTypeback to summary
private static BundleType parseBundleType(String str, OperatingSystem appImageOS)
pathOptionback to summary
private static OptionSpecBuilder<Path> pathOption(String name)
pathOptionMutatorback to summary
pack-priv static Consumer<OptionSpecBuilder<Path>> pathOptionMutator()
platformOptionback to summary
pack-priv static Predicate<OptionSpec<?>> platformOption(OperatingSystem os)

Returns a Predicate that returns true if the given option spec denotes an option supported on the given platform.

Parameters
os:OperatingSystem

the platform

Returns:Predicate<OptionSpec<?>>

the predicate

resourceKeySuffixback to summary
private static String resourceKeySuffix(OperatingSystem os)
sharedOptionback to summary
pack-priv static Predicate<OptionSpec<?>> sharedOption()

Returns a Predicate that returns true if the given option spec denotes an option supported on all platforms.

Returns:Predicate<OptionSpec<?>>

the predicate

stringOptionback to summary
private static OptionSpecBuilder<String> stringOption(String name)
stringOptionMutatorback to summary
pack-priv static Consumer<OptionSpecBuilder<String>> stringOptionMutator()
toExplodedPathListback to summary
private static <T> Function<OptionValue.Builder<RootedPath[][]>, OptionValue<List<Collection<RootedPath>>>> toExplodedPathList()
urlOptionback to summary
private static OptionSpecBuilder<String> urlOption(String name)
uuidOptionback to summary
private static OptionSpecBuilder<UUID> uuidOption(String name)
jdk.jpackage.internal.cli back to summary

pack-priv Class StandardOption.AddLauncherIllegalArgumentException

extends IllegalArgumentException
Class Inheritance
Known Direct Subclasses
jdk.jpackage.internal.cli.StandardOption.AddLauncherInvalidNameException, jdk.jpackage.internal.cli.StandardOption.AddLauncherInvalidPropertyFileException
Annotations
@SelfContainedException

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.IllegalArgumentException.serialVersionUID.

Constructor Detail

AddLauncherIllegalArgumentExceptionback to summary
pack-priv AddLauncherIllegalArgumentException(String message)
jdk.jpackage.internal.cli back to summary

pack-priv final Class StandardOption.AddLauncherInvalidNameException

extends AddLauncherIllegalArgumentException
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jdk.jpackage.internal.cli.StandardOption.AddLauncherIllegalArgumentException.serialVersionUID.

Constructor Detail

AddLauncherInvalidNameExceptionback to summary
pack-priv AddLauncherInvalidNameException(String message)
jdk.jpackage.internal.cli back to summary

pack-priv final Class StandardOption.AddLauncherInvalidPropertyFileException

extends AddLauncherIllegalArgumentException
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jdk.jpackage.internal.cli.StandardOption.AddLauncherIllegalArgumentException.serialVersionUID.

Constructor Detail

AddLauncherInvalidPropertyFileExceptionback to summary
pack-priv AddLauncherInvalidPropertyFileException(String msg)
jdk.jpackage.internal.cli back to summary

private final Class StandardOption.AddLauncherSyntaxException

extends IllegalArgumentException
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
pack-priv

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.IllegalArgumentException.serialVersionUID.

Constructor Detail

AddLauncherSyntaxExceptionback to summary
pack-priv AddLauncherSyntaxException()
jdk.jpackage.internal.cli back to summary

private final Class StandardOption.Arguments

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static Pattern

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
private static String
createPatternComponent(char quoteChar)

pack-priv static List<String>
getArgumentList(String inputString)

pack-priv static String
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

PATTERNback to summary
private static Pattern PATTERN

Constructor Detail

Argumentsback to summary
private Arguments()

Method Detail

createPatternComponentback to summary
private static String createPatternComponent(char quoteChar)
getArgumentListback to summary
pack-priv static List<String> getArgumentList(String inputString)
unquoteIfNeededback to summary
pack-priv static String unquoteIfNeeded(String in)
jdk.jpackage.internal.cli back to summary

pack-priv final Enum StandardOption.LauncherProperty

extends Enum<StandardOption.LauncherProperty>
implements OptionScope
Class Inheritance
All Implemented Interfaces
jdk.jpackage.internal.cli.OptionScope

Scope of options configuring a launcher.

Field Summary

Modifier and TypeField and Description
public static final StandardOption.LauncherProperty

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static StandardOption.LauncherProperty
public static StandardOption.LauncherProperty[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

VALUEback to summary
public static final StandardOption.LauncherProperty VALUE

Constructor Detail

LauncherPropertyback to summary
private LauncherProperty()

Method Detail

valueOfback to summary
public static StandardOption.LauncherProperty valueOf(String name)
valuesback to summary
public static StandardOption.LauncherProperty[] values()