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

public sealed Interface CustomLauncherIcon

extends LauncherIcon
permits Stub
Known Direct Implementers
jdk.jpackage.internal.model.CustomLauncherIcon.Stub
Imports
java.nio.file.Path, java.util.Objects, .Optional

Custom application launcher icon sourced from an external file.

Use create(Path) method to create an instance of this type.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static record
CustomLauncherIcon.Stub

Default implementation of CustomLauncherIcon type.

Method Summary

Modifier and TypeMethod and Description
public static CustomLauncherIcon

Returns:

CustomLauncherIcon instance
create
(Path
path to icon file
path
)

Creates object of type CustomLauncherIcon from the path to icon file.

public static Optional<CustomLauncherIcon>

Returns:

the given icon as CustomLauncherIcon type or an empty Optional instance
fromLauncherIcon
(LauncherIcon
application launcher icon object or null
icon
)

Returns the given icon as CustomLauncherIcon type or an empty Optional instance if the given icon object is not an instance of CustomLauncherIcon type.

public Path

Returns:

path to icon file
path
()

Returns path to icon file.

Method Detail

createback to summary
public static CustomLauncherIcon create(Path path)

Creates object of type CustomLauncherIcon from the path to icon file.

Parameters
path:Path

path to icon file

Returns:CustomLauncherIcon

CustomLauncherIcon instance

fromLauncherIconback to summary
public static Optional<CustomLauncherIcon> fromLauncherIcon(LauncherIcon icon)

Returns the given icon as CustomLauncherIcon type or an empty Optional instance if the given icon object is not an instance of CustomLauncherIcon type.

Parameters
icon:LauncherIcon

application launcher icon object or null

Returns:Optional<CustomLauncherIcon>

the given icon as CustomLauncherIcon type or an empty Optional instance

pathback to summary
public Path path()

Returns path to icon file.

Returns:Path

path to icon file

jdk.jpackage.internal.model back to summary

public final Record CustomLauncherIcon.Stub

extends Record
implements CustomLauncherIcon
Class Inheritance
All Implemented Interfaces
jdk.jpackage.internal.model.CustomLauncherIcon, jdk.jpackage.internal.model.LauncherIcon
Record Components
path:Path 

Default implementation of CustomLauncherIcon type.

Field Summary

Modifier and TypeField and Description
private final Path
path

Record Component accessed by path().

Constructor Summary

AccessConstructor and Description
public
Stub(Path path)

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 final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public Path
path()

Record Component getter of path.

Implements jdk.jpackage.internal.model.CustomLauncherIcon.path.

Returns path to icon file.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

pathback to summary
private final Path path

Record Component accessed by path().

Constructor Detail

Stubback to summary
public Stub(Path path)

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).
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.

pathback to summary
public Path path()

Record Component getter of path.

Implements jdk.jpackage.internal.model.CustomLauncherIcon.path.

Doc from jdk.jpackage.internal.model.CustomLauncherIcon.path.

Returns path to icon file.

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.