API Note
All paths of startup configurations of application launchers
returned by launchers() call must be relative to the path
returned by srcDir() call.
Package
| Modifier and Type | Class and Description |
|---|---|
| public static record | Application.
Default implementation of |
| Modifier and Type | Method and Description |
|---|---|
| public default List | Returns: the additional application launchers of this applicationGets the additional application launchers of this application. |
| public Collection | Returns: the source pathsGets the source paths that should be copied into
|
| public default Path | Returns: the name of the root app image directory of this applicationGets the name of the root app image directory of this application. |
| public default Optional | Returns: the unresolved app image layout of this application asApplicationLayoutGets the unresolved app image layout of this application as
|
| public Collection | Returns: the source pathsGets the source paths that should be copied into
|
| public String | |
| public String | |
| public Map | Returns: the additional properties of this application for the application entry in ".jpackage.xml" fileGets the additional properties of this application for the application entry in the app image (".jpackage.xml") file. |
| public default Stream | Returns: the file associations of all application launchers of this applicationGets the file associations of all application launchers of this application. |
| public AppImageLayout | Returns: the unresolved app image layout of this applicationGets the unresolved app image layout of this application. |
| public default boolean | Returns: true if this application is Java runtimeReturns |
| public default boolean | Returns: true if any of application launchers of this application
are configured as servicesReturns |
| public List | Returns: the application launchers of this applicationGets the application launchers of this application. |
| public default Optional | Returns: the main application launcher of this applicationReturns the main application launcher of this application or an empty
|
| public String | |
| public Optional | Returns: the runtime builder of this applicationGets the runtime builder of this application if available or an empty
|
| public String | |
| public String |
| additionalLaunchers | back to summary |
|---|---|
| public default List Gets the additional application launchers of this application. Returns an empty list if this application doesn't have additional launchers.
Returns an empty list if
| |
| appDirSources | back to summary |
|---|---|
| public Collection Gets the source paths that should be copied into
Source paths are supposed to contain the applications's classes and other resources.
| |
| appImageDirName | back to summary |
|---|---|
| public default Path appImageDirName() Gets the name of the root app image directory of this application.
| |
| asApplicationLayout | back to summary |
|---|---|
| public default Optional Gets the unresolved app image layout of this application as
Returns an empty
| |
| contentDirSources | back to summary |
|---|---|
| public Collection Gets the source paths that should be copied into
| |
| copyright | back to summary |
|---|---|
| public String copyright() Gets the copyright of this application.
| |
| description | back to summary |
|---|---|
| public String description() Gets the description of this application.
| |
| extraAppImageFileData | back to summary |
|---|---|
| public Map Gets the additional properties of this application for the application entry in the app image (".jpackage.xml") file. | |
| fileAssociations | back to summary |
|---|---|
| public default Stream Gets the file associations of all application launchers of this application.
| |
| imageLayout | back to summary |
|---|---|
| public AppImageLayout imageLayout() Gets the unresolved app image layout of this application.
| |
| isRuntime | back to summary |
|---|---|
| public default boolean isRuntime() Returns
| |
| isService | back to summary |
|---|---|
| public default boolean isService() Returns
| |
| launchers | back to summary |
|---|---|
| public List Gets the application launchers of this application. If the returned list is not empty, the first element in the list is the main launcher.
Returns an empty list if
| |
| mainLauncher | back to summary |
|---|---|
| public default Optional Returns the main application launcher of this application or an empty
Returns an empty
| |
| name | back to summary |
|---|---|
| public String name() Gets the name of this application.
| |
| runtimeBuilder | back to summary |
|---|---|
| public Optional Gets the runtime builder of this application if available or an empty
| |
| vendor | back to summary |
|---|---|
| public String vendor() Gets the vendor of this application.
| |
| version | back to summary |
|---|---|
| public String version() Gets the version of this application.
| |
Application interface.
| Modifier and Type | Field and Description |
|---|---|
| private final Collection | appDirSources
Record Component accessed by appDirSources(). |
| private final Collection | contentDirSources
Record Component accessed by contentDirSources(). |
| private final String | copyright
Record Component accessed by copyright(). |
| private final String | description
Record Component accessed by description(). |
| private final Map | extraAppImageFileData
Record Component accessed by extraAppImageFileData(). |
| private final AppImageLayout | imageLayout
Record Component accessed by imageLayout(). |
| private final List | launchers
Record Component accessed by launchers(). |
| private final String | |
| private final Optional | runtimeBuilder
Record Component accessed by runtimeBuilder(). |
| private final String | |
| private final String |
| Access | Constructor and Description |
|---|---|
| public | Stub(String name, String description, String version, String vendor, String copyright, Collection<RootedPath> appDirSources, Collection<RootedPath> contentDirSources, AppImageLayout imageLayout, Optional<RuntimeBuilder> runtimeBuilder, List<Launcher> launchers, Map<String, String> extraAppImageFileData)
|
| Modifier and Type | Method and Description |
|---|---|
| public Collection | appDirSources()
Record Component getter of appDirSources. Implements jdk. Gets the source paths that should be copied into
|
| public Collection | contentDirSources()
Record Component getter of contentDirSources. Implements jdk. Gets the source paths that should be copied into
|
| public String | copyright()
Record Component getter of copyright. Implements jdk. Gets the copyright of this application.
|
| public String | description()
Record Component getter of description. Implements jdk. Gets the description of this application.
|
| public final boolean | equals(Object o)
Implements abstract java. Indicates whether some other object is "equal to" this one. |
| public Map | extraAppImageFileData()
Record Component getter of extraAppImageFileData. Implements jdk. Gets the additional properties of this application for the application entry in the app image (".jpackage.xml") file.
|
| public final int | |
| public AppImageLayout | imageLayout()
Record Component getter of imageLayout. Implements jdk. Gets the unresolved app image layout of this application.
|
| public List | launchers()
Record Component getter of launchers. Implements jdk. Gets the application launchers of this application.
|
| public String | name()
Record Component getter of name. Implements jdk. Gets the name of this application.
|
| public Optional | runtimeBuilder()
Record Component getter of runtimeBuilder. Implements jdk. Gets the runtime builder of this application if available or an empty
|
| public final String | toString()
Implements abstract java. Returns a string representation of the record. |
| public String | vendor()
Record Component getter of vendor. Implements jdk. Gets the vendor of this application.
|
| public String | version()
Record Component getter of version. Implements jdk. Gets the version of this application.
|
| appDirSources | back to summary |
|---|---|
| private final Collection<RootedPath> appDirSources Record Component accessed by appDirSources(). | |
| contentDirSources | back to summary |
|---|---|
| private final Collection<RootedPath> contentDirSources Record Component accessed by contentDirSources(). | |
| copyright | back to summary |
|---|---|
| private final String copyright Record Component accessed by copyright(). | |
| description | back to summary |
|---|---|
| private final String description Record Component accessed by description(). | |
| extraAppImageFileData | back to summary |
|---|---|
| private final Map<String, String> extraAppImageFileData Record Component accessed by extraAppImageFileData(). | |
| imageLayout | back to summary |
|---|---|
| private final AppImageLayout imageLayout Record Component accessed by imageLayout(). | |
| launchers | back to summary |
|---|---|
| private final List<Launcher> launchers Record Component accessed by launchers(). | |
| name | back to summary |
|---|---|
| private final String name Record Component accessed by name(). | |
| runtimeBuilder | back to summary |
|---|---|
| private final Optional<RuntimeBuilder> runtimeBuilder Record Component accessed by runtimeBuilder(). | |
| vendor | back to summary |
|---|---|
| private final String vendor Record Component accessed by vendor(). | |
| version | back to summary |
|---|---|
| private final String version Record Component accessed by version(). | |
| Stub | back to summary |
|---|---|
| public Stub(String name, String description, String version, String vendor, String copyright, Collection<RootedPath> appDirSources, Collection<RootedPath> contentDirSources, AppImageLayout imageLayout, Optional<RuntimeBuilder> runtimeBuilder, List<Launcher> launchers, Map<String, String> extraAppImageFileData) | |
| appDirSources | back to summary |
|---|---|
| public Collection Record Component getter of appDirSources. Implements jdk. Doc from jdk. Gets the source paths that should be copied into
Source paths are supposed to contain the applications's classes and other resources. | |
| contentDirSources | back to summary |
|---|---|
| public Collection Record Component getter of contentDirSources. Implements jdk. Doc from jdk. Gets the source paths that should be copied into
| |
| copyright | back to summary |
|---|---|
| public String copyright() Record Component getter of copyright. Implements jdk. Doc from jdk. Gets the copyright of this application. | |
| description | back to summary |
|---|---|
| public String description() Record Component getter of description. Implements jdk. Doc from jdk. Gets the description of this application. | |
| equals | back to summary |
|---|---|
| public final boolean equals(Object o) Implements abstract java. Doc from java. Indicates whether some other object is "equal to" this one. In addition
to the general contract of
R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
| |
| extraAppImageFileData | back to summary |
|---|---|
| public Map Record Component getter of extraAppImageFileData. Implements jdk. Doc from jdk. Gets the additional properties of this application for the application entry in the app image (".jpackage.xml") file. | |
| hashCode | back to summary |
|---|---|
| public final int hashCode() Implements abstract java. Doc from java. Returns a hash code value for the record.
Obeys the general contract of | |
| imageLayout | back to summary |
|---|---|
| public AppImageLayout imageLayout() Record Component getter of imageLayout. Implements jdk. Doc from jdk. Gets the unresolved app image layout of this application. | |
| launchers | back to summary |
|---|---|
| public List Record Component getter of launchers. Implements jdk. Doc from jdk. Gets the application launchers of this application. If the returned list is not empty, the first element in the list is the main launcher.
Returns an empty list if | |
| name | back to summary |
|---|---|
| public String name() Record Component getter of name. Implements jdk. Doc from jdk. Gets the name of this application. | |
| runtimeBuilder | back to summary |
|---|---|
| public Optional Record Component getter of runtimeBuilder. Implements jdk. Doc from jdk. Gets the runtime builder of this application if available or an empty
| |
| toString | back to summary |
|---|---|
| public final String toString() Implements abstract java. Doc from java. Returns a string representation of the record.
In accordance with the general contract of 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. | |
| vendor | back to summary |
|---|---|
| public String vendor() Record Component getter of vendor. Implements jdk. Doc from jdk. Gets the vendor of this application. | |
| version | back to summary |
|---|---|
| public String version() Record Component getter of version. Implements jdk. Doc from jdk. Gets the version of this application. | |