APIdia Launch Partner
Top Description Inners Methods
jdk.jpackage.internal.model

public sealed Interface ExternalApplication

permits DefaultExternalApplication
Known Direct Implementers
jdk.jpackage.internal.model.ExternalApplication.Internal.DefaultExternalApplication
Static Imports
jdk.jpackage.internal.cli.StandardOption.APP_VERSION, .StandardOption.NAME

Description of an external application image.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static interface
ExternalApplication.LauncherInfo

Launcher description.

Method Summary

Modifier and TypeMethod and Description
public List<ExternalApplication.LauncherInfo>

Returns:

the list of additional launchers configured for the application
addLaunchers
()

Returns the list of additional launchers configured for the application.

public String

Returns:

the application name
appName
()

Returns application name.

public String

Returns:

the application version
appVersion
()

Returns application version.

public static ExternalApplication
create(Options appOptions, List<Options> addLauncherOptions, OperatingSystem os)

public Options

Returns:

the additional properties
extra
()

Returns additional properties.

public ExternalApplication.LauncherInfo

Returns:

the main launcher configured for the application
mainLauncher
()

Returns the main launcher configured for the application.

Method Detail

addLaunchersback to summary
public List<ExternalApplication.LauncherInfo> addLaunchers()

Returns the list of additional launchers configured for the application.

Returns an empty list for an application without additional launchers.

Returns:List<ExternalApplication.LauncherInfo>

the list of additional launchers configured for the application

appNameback to summary
public String appName()

Returns application name.

Returns:String

the application name

appVersionback to summary
public String appVersion()

Returns application version.

Returns:String

the application version

createback to summary
public static ExternalApplication create(Options appOptions, List<Options> addLauncherOptions, OperatingSystem os)
extraback to summary
public Options extra()

Returns additional properties.

Returns:Options

the additional properties

mainLauncherback to summary
public ExternalApplication.LauncherInfo mainLauncher()

Returns the main launcher configured for the application.

Returns:ExternalApplication.LauncherInfo

the main launcher configured for the application

jdk.jpackage.internal.model back to summary

public final Class ExternalApplication.Internal

extends Object
Class Inheritance

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static record
private static record

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Internalback to summary
private Internal()
jdk.jpackage.internal.model back to summary

private final Record ExternalApplication.Internal.DefaultExternalApplication

extends Record
implements ExternalApplication
Class Inheritance
All Implemented Interfaces
jdk.jpackage.internal.model.ExternalApplication
Record Components
options:Options 
addLaunchers:List<ExternalApplication.LauncherInfo> 

Field Summary

Modifier and TypeField and Description
private final List<ExternalApplication.LauncherInfo>
addLaunchers

Record Component accessed by addLaunchers().

private final Options
options

Record Component accessed by options().

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public List<ExternalApplication.LauncherInfo>
addLaunchers()

Record Component getter of addLaunchers.

Implements jdk.jpackage.internal.model.ExternalApplication.addLaunchers.

Returns the list of additional launchers configured for the application.

public String
public String
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public Options
extra()

Implements jdk.jpackage.internal.model.ExternalApplication.extra.

Returns additional properties.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public ExternalApplication.LauncherInfo
mainLauncher()

Implements jdk.jpackage.internal.model.ExternalApplication.mainLauncher.

Returns the main launcher configured for the application.

public Options
options()

Record Component getter of options.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

addLaunchersback to summary
private final List<ExternalApplication.LauncherInfo> addLaunchers

Record Component accessed by addLaunchers().

optionsback to summary
private final Options options

Record Component accessed by options().

Constructor Detail

DefaultExternalApplicationback to summary
pack-priv DefaultExternalApplication(Options options, List<ExternalApplication.LauncherInfo> addLaunchers)

Method Detail

addLaunchersback to summary
public List<ExternalApplication.LauncherInfo> addLaunchers()

Record Component getter of addLaunchers.

Implements jdk.jpackage.internal.model.ExternalApplication.addLaunchers.

Doc from jdk.jpackage.internal.model.ExternalApplication.addLaunchers.

Returns the list of additional launchers configured for the application.

Returns an empty list for an application without additional launchers.

appNameback to summary
public String appName()

Implements jdk.jpackage.internal.model.ExternalApplication.appName.

Doc from jdk.jpackage.internal.model.ExternalApplication.appName.

Returns application name.

Annotations
@Override
appVersionback to summary
public String appVersion()

Implements jdk.jpackage.internal.model.ExternalApplication.appVersion.

Doc from jdk.jpackage.internal.model.ExternalApplication.appVersion.

Returns application version.

Annotations
@Override
equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
extraback to summary
public Options extra()

Implements jdk.jpackage.internal.model.ExternalApplication.extra.

Doc from jdk.jpackage.internal.model.ExternalApplication.extra.

Returns additional properties.

Annotations
@Override
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

mainLauncherback to summary
public ExternalApplication.LauncherInfo mainLauncher()

Implements jdk.jpackage.internal.model.ExternalApplication.mainLauncher.

Doc from jdk.jpackage.internal.model.ExternalApplication.mainLauncher.

Returns the main launcher configured for the application.

Annotations
@Override
optionsback to summary
public Options options()

Record Component getter of options.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

jdk.jpackage.internal.model back to summary

private final Record ExternalApplication.Internal.DefaultLauncherInfo

extends Record
implements LauncherInfo
Class Inheritance
All Implemented Interfaces
jdk.jpackage.internal.model.ExternalApplication.LauncherInfo
Record Components
options:Options 

Field Summary

Modifier and TypeField and Description
private final Options
options

Record Component accessed by options().

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public Options
extra()

Implements jdk.jpackage.internal.model.ExternalApplication.LauncherInfo.extra.

Gets optional properties of the launcher.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public String
name()

Implements jdk.jpackage.internal.model.ExternalApplication.LauncherInfo.name.

Gets the name of the launcher.

public Options
options()

Record Component getter of options.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

optionsback to summary
private final Options options

Record Component accessed by options().

Constructor Detail

DefaultLauncherInfoback to summary
pack-priv DefaultLauncherInfo(Options options)

Method Detail

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
extraback to summary
public Options extra()

Implements jdk.jpackage.internal.model.ExternalApplication.LauncherInfo.extra.

Doc from jdk.jpackage.internal.model.ExternalApplication.LauncherInfo.extra.

Gets optional properties of the launcher.

Annotations
@Override
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

nameback to summary
public String name()

Implements jdk.jpackage.internal.model.ExternalApplication.LauncherInfo.name.

Doc from jdk.jpackage.internal.model.ExternalApplication.LauncherInfo.name.

Gets the name of the launcher.

Annotations
@Override
optionsback to summary
public Options options()

Record Component getter of options.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

jdk.jpackage.internal.model back to summary

public sealed Interface ExternalApplication.LauncherInfo

permits DefaultLauncherInfo
Known Direct Implementers
jdk.jpackage.internal.model.ExternalApplication.Internal.DefaultLauncherInfo

Launcher description.

Method Summary

Modifier and TypeMethod and Description
public default Options

Returns:

the Options representation of this instance
asOptions
()

Returns Options representation of this instance.

public static ExternalApplication.LauncherInfo
create(Options options)

public Options

Returns:

the optional properties of the launcher
extra
()

Gets optional properties of the launcher.

public String

Returns:

the name of the launcher
name
()

Gets the name of the launcher.

Method Detail

asOptionsback to summary
public default Options asOptions()

Returns Options representation of this instance.

Return value contains the value of NAME property merged with the Options instance returned by the extra() method.

Returns:Options

the Options representation of this instance

createback to summary
public static ExternalApplication.LauncherInfo create(Options options)
extraback to summary
public Options extra()

Gets optional properties of the launcher.

Returns:Options

the optional properties of the launcher

nameback to summary
public String name()

Gets the name of the launcher.

Returns:String

the name of the launcher