Modifier and Type	Class and Description
pack-priv static enum	OptionSpec.MergePolicy

Field Summary

Modifier and Type	Field and Description
private final Optional<OptionValueConverter<String, T>>	converter Record Component accessed by converter(). the converter.
private final Optional<T>	defaultOptionalValue Record Component accessed by defaultOptionalValue(). the default optional value or an empty `Optional` instance if the option has a mandatory value or doesn't have a value
private final String	description Record Component accessed by description(). the description.
private final OptionSpec.MergePolicy	mergePolicy Record Component accessed by mergePolicy(). the merge policy
private final List<OptionName>	names Record Component accessed by names(). the names.
private final Set<OptionScope>	scope Record Component accessed by scope(). the scope.
private final Optional<String>	valuePattern Record Component accessed by valuePattern(). the value pattern.

Constructor Summary

Access	Constructor and Description
pack-priv	OptionSpec(List<OptionName> names, Optional<OptionValueConverter<String, T>> converter, Set<OptionScope> scope, OptionSpec.MergePolicy mergePolicy, Optional<T> defaultOptionalValue, Optional<String> valuePattern, String description)

Method Summary

Modifier and Type	Method and Description
pack-priv <U> Optional<OptionArrayValueConverter<U>>	arrayValueConverter()
pack-priv Result<T>	convert(OptionName optionName, StringToken optionValue)
public Optional<OptionValueConverter<String, T>>	converter() Record Component getter of converter. Record Component the converter.
pack-priv Stream<OptionSpec<T>>	Returns: the stream of copy option spec objects each having a single name copyForEveryName() Returns a stream of copy option spec objects, each having a single name.
pack-priv <U> OptionSpec<U>	copyWithConverter(OptionValueConverter<String, U> converter)
pack-priv OptionSpec<T>	copyWithDescription(String description)
pack-priv OptionSpec<T>	copyWithName(OptionName name)
public Optional<T>	defaultOptionalValue() Record Component getter of defaultOptionalValue. Record Component the default optional value or an empty `Optional` instance if the option has a mandatory value or doesn't have a value
public String	description() Record Component getter of description. Record Component the description.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
pack-priv List<OptionName>	findNamesIn(Options cmdline)
pack-priv OptionName	getFirstNameIn(Options cmdline)
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
pack-priv boolean	hasValue()
pack-priv boolean	isValueOptional()
public OptionSpec.MergePolicy	mergePolicy() Record Component getter of mergePolicy. Record Component the merge policy
pack-priv OptionName	Returns: the first name of this option spec name() Returns the first (primary) name of this option spec.
public List<OptionName>	names() Record Component getter of names. Record Component the names.
pack-priv List<OptionName>	Returns: the additional names otherNames() Returns all names but the first of this option spec.
public Set<OptionScope>	scope() Record Component getter of scope. Record Component the scope.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public Optional<String>	valuePattern() Record Component getter of valuePattern. Record Component the value pattern.
pack-priv Class<? extends T>	valueType()
private static <T> Optional<Class<? extends T>>	valueType(Optional<OptionValueConverter<String, T>> valueConverter)

Field Detail

converter back to summary

converter	back to summary
private final Optional<OptionValueConverter<String, T>> converter Record Component accessed by converter(). the converter. Converts from a `String` to an object of type `T`

private final Optional<OptionValueConverter<String, T>> converter

Record Component accessed by converter().

the converter. Converts from a String to an object of type T

defaultOptionalValue back to summary

defaultOptionalValue	back to summary
private final Optional<T> defaultOptionalValue Record Component accessed by defaultOptionalValue(). the default optional value or an empty `Optional` instance if the option has a mandatory value or doesn't have a value

private final Optional<T> defaultOptionalValue

Record Component accessed by defaultOptionalValue().

the default optional value or an empty Optional instance if the option has a mandatory value or doesn't have a value

description	back to summary
private final String description Record Component accessed by description(). the description. Used in help output

description

back to summary

private final String description

Record Component accessed by description().

the description. Used in help output

mergePolicy	back to summary
private final OptionSpec.MergePolicy mergePolicy Record Component accessed by mergePolicy(). the merge policy

mergePolicy

back to summary

private final OptionSpec.MergePolicy mergePolicy

Record Component accessed by mergePolicy().

the merge policy

names	back to summary
private final List<OptionName> names Record Component accessed by names(). the names. Must be non-empty

names

back to summary

private final List<OptionName> names

Record Component accessed by names().

the names. Must be non-empty

scope	back to summary
private final Set<OptionScope> scope Record Component accessed by scope(). the scope. Must be non-empty

scope

back to summary

private final Set<OptionScope> scope

Record Component accessed by scope().

the scope. Must be non-empty

valuePattern	back to summary
private final Optional<String> valuePattern Record Component accessed by valuePattern(). the value pattern. Used in help output

valuePattern

back to summary

private final Optional<String> valuePattern

Record Component accessed by valuePattern().

the value pattern. Used in help output

Constructor Detail

OptionSpec	back to summary
pack-priv OptionSpec(List<OptionName> names, Optional<OptionValueConverter<String, T>> converter, Set<OptionScope> scope, OptionSpec.MergePolicy mergePolicy, Optional<T> defaultOptionalValue, Optional<String> valuePattern, String description)

Method Detail

arrayValueConverter	back to summary
pack-priv <U> Optional<OptionArrayValueConverter<U>> arrayValueConverter() Annotations @SuppressWarnings:unchecked

convert	back to summary
pack-priv Result<T> convert(OptionName optionName, StringToken optionValue)

converter back to summary

converter	back to summary
public Optional<OptionValueConverter<String, T>> converter() Record Component getter of converter. Record Component the converter. Converts from a `String` to an object of type `T`

public Optional<OptionValueConverter<String, T>> converter()

Record Component getter of converter.

Record Component: the converter. Converts from a String to an object of type T

copyForEveryName	back to summary
pack-priv Stream<OptionSpec<T>> copyForEveryName() Returns a stream of copy option spec objects, each having a single name. If the option has three names "a", "b", and "c", the stream will have three option spec objects each with a single name. The first will have name "a", the second - "b", and the third "c". Returns:Stream<OptionSpec<T>> the stream of copy option spec objects each having a single name

copyForEveryName

back to summary

pack-priv Stream<OptionSpec<T>> copyForEveryName()

Returns a stream of copy option spec objects, each having a single name.

If the option has three names "a", "b", and "c", the stream will have three option spec objects each with a single name. The first will have name "a", the second - "b", and the third "c".

Returns:Stream<OptionSpec<T>>: the stream of copy option spec objects each having a single name

copyWithConverter	back to summary
pack-priv <U> OptionSpec<U> copyWithConverter(OptionValueConverter<String, U> converter)

copyWithDescription	back to summary
pack-priv OptionSpec<T> copyWithDescription(String description)

copyWithName	back to summary
pack-priv OptionSpec<T> copyWithName(OptionName name)

defaultOptionalValue back to summary

defaultOptionalValue	back to summary
public Optional<T> defaultOptionalValue() Record Component getter of defaultOptionalValue. Record Component the default optional value or an empty `Optional` instance if the option has a mandatory value or doesn't have a value

public Optional<T> defaultOptionalValue()

Record Component getter of defaultOptionalValue.

Record Component: the default optional value or an empty Optional instance if the option has a mandatory value or doesn't have a value

description	back to summary
public String description() Record Component getter of description. Record Component the description. Used in help output

description

back to summary

public String description()

Record Component getter of description.

Record Component: the description. Used in help output

equals back to summary

equals	back 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)`.

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

findNamesIn	back to summary
pack-priv List<OptionName> findNamesIn(Options cmdline)

getFirstNameIn	back to summary
pack-priv OptionName getFirstNameIn(Options cmdline)

hashCode back to summary

hashCode	back 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.

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.

hasValue	back to summary
pack-priv boolean hasValue()

isValueOptional	back to summary
pack-priv boolean isValueOptional()

mergePolicy	back to summary
public OptionSpec.MergePolicy mergePolicy() Record Component getter of mergePolicy. Record Component the merge policy

mergePolicy

back to summary

public OptionSpec.MergePolicy mergePolicy()

Record Component getter of mergePolicy.

Record Component: the merge policy

name	back to summary
pack-priv OptionName name() Returns the first (primary) name of this option spec. Returns:OptionName the first name of this option spec

name

back to summary

pack-priv OptionName name()

Returns the first (primary) name of this option spec.

Returns:OptionName: the first name of this option spec

names	back to summary
public List<OptionName> names() Record Component getter of names. Record Component the names. Must be non-empty

names

back to summary

public List<OptionName> names()

Record Component getter of names.

Record Component: the names. Must be non-empty

otherNames	back to summary
pack-priv List<OptionName> otherNames() Returns all names but the first of this option spec. Returns an empty list if the option spec has only one name. Returns:List<OptionName> the additional names

otherNames

back to summary

pack-priv List<OptionName> otherNames()

Returns all names but the first of this option spec. Returns an empty list if the option spec has only one name.

Returns:List<OptionName>: the additional names

scope	back to summary
public Set<OptionScope> scope() Record Component getter of scope. Record Component the scope. Must be non-empty

scope

back to summary

public Set<OptionScope> scope()

Record Component getter of scope.

Record Component: the scope. Must be non-empty

toString back to summary

toString	back 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.

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.

valuePattern	back to summary
public Optional<String> valuePattern() Record Component getter of valuePattern. Record Component the value pattern. Used in help output

valuePattern

back to summary

public Optional<String> valuePattern()

Record Component getter of valuePattern.

Record Component: the value pattern. Used in help output

valueType	back to summary
pack-priv Class<? extends T> valueType()

valueType	back to summary
private static <T> Optional<Class<? extends T>> valueType(Optional<OptionValueConverter<String, T>> valueConverter)

jdk.jpackage.internal.cli back to summary

pack-priv final Enum OptionSpec.MergePolicy

Class Inheritance

extends Enum<OptionSpec.MergePolicy>

java.lang.Object
java.lang.Enum
jdk.jpackage.internal.cli.OptionSpec.MergePolicy

Field Summary

Modifier and Type	Field and Description
public static final OptionSpec.MergePolicy	CONCATENATE
public static final OptionSpec.MergePolicy	USE_FIRST
public static final OptionSpec.MergePolicy	USE_LAST

Constructor Summary

Access	Constructor and Description
private	MergePolicy()

Method Summary

Modifier and Type	Method and Description
public static OptionSpec.MergePolicy	valueOf(String name)
public static OptionSpec.MergePolicy[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CONCATENATE	back to summary
public static final OptionSpec.MergePolicy CONCATENATE

USE_FIRST	back to summary
public static final OptionSpec.MergePolicy USE_FIRST

USE_LAST	back to summary
public static final OptionSpec.MergePolicy USE_LAST

Constructor Detail

MergePolicy	back to summary
private MergePolicy()

Method Detail

valueOf	back to summary
public static OptionSpec.MergePolicy valueOf(String name)

values	back to summary
public static OptionSpec.MergePolicy[] values()

pack-priv final Record OptionSpec<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum OptionSpec.MergePolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail