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

pack-priv final Record PackageProperty

extends Record
Class Inheritance
Record Components
name:String
the property name (e.g.: "Architecture", "Version")
expectedValue:String
the expected value of the property
subtrituteString:Optional<String>
the substitute string in the jpackage resource if applicable (e.g.: "APPLICATION_PACKAGE", "APPLICATION_VERSION")
customResource:String
the name of the custom resource file from the resource directory in which this package property can be set
Imports
java.util.Objects, .Optional, jdk.jpackage.internal.model.ConfigException
Linux package property.

Field Summary

Modifier and TypeField and Description
private final String
customResource

Record Component accessed by customResource().

the name of the custom resource file from the resource directory in which this package property can be set
private final String
expectedValue

Record Component accessed by expectedValue().

the expected value of the property
private final String
name

Record Component accessed by name().

the property name (e.g.: "Architecture", "Version")
private final Optional<String>
subtrituteString

Record Component accessed by subtrituteString().

the substitute string in the jpackage resource if applicable (e.g.: "APPLICATION_PACKAGE", "APPLICATION_VERSION")

Constructor Summary

AccessConstructor and Description
pack-priv
PackageProperty(String name, String expectedValue, Optional<String> subtrituteString, String customResource)

pack-priv
PackageProperty(String name, String expectedValue, String subtrituteString, String resourceName)

pack-priv
PackageProperty(String name, String expectedValue, String resourceName)

Method Summary

Modifier and TypeMethod and Description
public String
customResource()

Record Component getter of customResource.

Record Component the name of the custom resource file from the resource directory in which this package property can be set

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

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

public String
expectedValue()

Record Component getter of expectedValue.

Record Component the expected value of the property

private String
formatAdvice(String actualValue)

private String
formatErrorMessage(String actualValue)

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public String
name()

Record Component getter of name.

Record Component the property name (e.g.: "Architecture", "Version")

public Optional<String>
subtrituteString()

Record Component getter of subtrituteString.

Record Component the substitute string in the jpackage resource if applicable (e.g.: "APPLICATION_PACKAGE", "APPLICATION_VERSION")

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

pack-priv ConfigException
verifyValue(String actualValue)

Field Detail

customResourceback to summary
private final String customResource

Record Component accessed by customResource().

the name of the custom resource file from the resource directory in which this package property can be set

expectedValueback to summary
private final String expectedValue

Record Component accessed by expectedValue().

the expected value of the property

nameback to summary
private final String name

Record Component accessed by name().

the property name (e.g.: "Architecture", "Version")

subtrituteStringback to summary
private final Optional<String> subtrituteString

Record Component accessed by subtrituteString().

the substitute string in the jpackage resource if applicable (e.g.: "APPLICATION_PACKAGE", "APPLICATION_VERSION")

Constructor Detail

PackagePropertyback to summary
pack-priv PackageProperty(String name, String expectedValue, Optional<String> subtrituteString, String customResource)
PackagePropertyback to summary
pack-priv PackageProperty(String name, String expectedValue, String subtrituteString, String resourceName)
PackagePropertyback to summary
pack-priv PackageProperty(String name, String expectedValue, String resourceName)

Method Detail

customResourceback to summary
public String customResource()

Record Component getter of customResource.

Record Component
the name of the custom resource file from the resource directory in which this package property can be set
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).
expectedValueback to summary
public String expectedValue()

Record Component getter of expectedValue.

Record Component
the expected value of the property
formatAdviceback to summary
private String formatAdvice(String actualValue)
formatErrorMessageback to summary
private String formatErrorMessage(String actualValue)
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()

Record Component getter of name.

Record Component
the property name (e.g.: "Architecture", "Version")
subtrituteStringback to summary
public Optional<String> subtrituteString()

Record Component getter of subtrituteString.

Record Component
the substitute string in the jpackage resource if applicable (e.g.: "APPLICATION_PACKAGE", "APPLICATION_VERSION")
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.

verifyValueback to summary
pack-priv ConfigException verifyValue(String actualValue)