OpenJDK 27 · jdk.jpackage.internal.cli.Options · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public static Options	concat(Options... options)
public boolean	contains(OptionName optionName)
public default boolean	contains(OptionIdentifier id)
public default boolean	contains(WithOptionIdentifier withId)
public default Options	Returns: a copy of this instance with all but the given option identifiers filtered out copyWith(OptionIdentifier... the identifiers to keep in the copy ids) Creates a copy of this instance with all but the given option identifiers filtered out.
public default Options	Returns: a copy of this instance with all but the given option identifiers filtered out copyWith(Iterable<? extends OptionIdentifier> the identifiers to keep in the copy ids) Creates a copy of this instance with all but the given option identifiers filtered out.
public default Options	copyWithDefaultValue(WithOptionIdentifier withId, Object value)
public default Options	copyWithDefaultValue(WithOptionIdentifier withId, Supplier<Object> valueSupplier)
public default Options	Returns: a copy of this instance without the given option identifiers copyWithout(OptionIdentifier... the identifiers to exclude ids) Creates a copy of this instance without the given option identifiers.
public Options	Returns: a copy of this instance without the given option identifiers copyWithout(Iterable<? extends OptionIdentifier> the identifiers to exclude ids) Creates a copy of this instance without the given option identifiers.
public default Options	copyWithParent(Options other)
public Optional<Object>	find(OptionIdentifier id)
public default Optional<Object>	find(WithOptionIdentifier withId)
public Set<? extends OptionIdentifier>	ids()
public static Options	Returns: a new `Options` instance of(Map<? extends WithOptionIdentifier, Object> the map of objects with option identifiers and associated option values map) Creates `Options` instance from the map of objects with option identifiers and associated option values.
public static Options	Returns: a new `Options` instance ofIDs(Map<OptionIdentifier, Object> the map of option identifiers and associated option values map) Creates `Options` instance from the map of option identifiers and associated option values.
private static DefaultOptions	toDefaultOptions(Options v)
public default Map<OptionIdentifier, Object>	Returns: the map representation of this instance. toMap() Returns a map representation of this instance.

Method Detail

concat	back to summary
public static Options concat(Options... options)

contains	back to summary
public boolean contains(OptionName optionName)

contains	back to summary
public default boolean contains(OptionIdentifier id)

contains	back to summary
public default boolean contains(WithOptionIdentifier withId)

copyWith back to summary

copyWith	back to summary
public default Options copyWith(OptionIdentifier... ids) Creates a copy of this instance with all but the given option identifiers filtered out. `contains(OptionIdentifier)` called on the returned instance with any identifiers not in the given array will return `false`. `contains(OptionName)` called on the returned instance with any name returned by `OptionSpec#name()` method called on option specifications of identifiers of type `Option` not from the given identifier array will return `false`. Parameters ids:OptionIdentifier[] the identifiers to keep in the copy Returns:Options a copy of this instance with all but the given option identifiers filtered out

public default Options copyWith(OptionIdentifier... ids)

Creates a copy of this instance with all but the given option identifiers filtered out.

contains(OptionIdentifier) called on the returned instance with any identifiers not in the given array will return false. contains(OptionName) called on the returned instance with any name returned by OptionSpec#name() method called on option specifications of identifiers of type Option not from the given identifier array will return false.

Parameters

ids:OptionIdentifier[]: the identifiers to keep in the copy

Returns:Options

a copy of this instance with all but the given option identifiers filtered out

copyWith back to summary

copyWith	back to summary
public default Options copyWith(Iterable<? extends OptionIdentifier> ids) Creates a copy of this instance with all but the given option identifiers filtered out. Same as `copyWith(OptionIdentifier...)` but takes an `Iterable<OptionIdentifier>` instead of an `OptionIdentifier[]`. Parameters ids:Iterable<? extends OptionIdentifier> the identifiers to keep in the copy Returns:Options a copy of this instance with all but the given option identifiers filtered out

public default Options copyWith(Iterable<? extends OptionIdentifier> ids)

Creates a copy of this instance with all but the given option identifiers filtered out.

Same as copyWith(OptionIdentifier...) but takes an Iterable<OptionIdentifier> instead of an OptionIdentifier[].

Parameters

ids:Iterable<? extends OptionIdentifier>: the identifiers to keep in the copy

Returns:Options

a copy of this instance with all but the given option identifiers filtered out

copyWithDefaultValue	back to summary
public default Options copyWithDefaultValue(WithOptionIdentifier withId, Object value)

copyWithDefaultValue	back to summary
public default Options copyWithDefaultValue(WithOptionIdentifier withId, Supplier<Object> valueSupplier)

copyWithout back to summary

copyWithout	back to summary
public default Options copyWithout(OptionIdentifier... ids) Creates a copy of this instance without the given option identifiers. `contains(OptionIdentifier)` called on the return instance with any of the given identifiers will return `false`. `contains(OptionName)` called on the return instance with any option name of option specifications associated with given identifiers will return `false`. Parameters ids:OptionIdentifier[] the identifiers to exclude Returns:Options a copy of this instance without the given option identifiers

public default Options copyWithout(OptionIdentifier... ids)

Creates a copy of this instance without the given option identifiers.

contains(OptionIdentifier) called on the return instance with any of the given identifiers will return false. contains(OptionName) called on the return instance with any option name of option specifications associated with given identifiers will return false.

Parameters

ids:OptionIdentifier[]: the identifiers to exclude

Returns:Options

a copy of this instance without the given option identifiers

copyWithout back to summary

copyWithout	back to summary
public Options copyWithout(Iterable<? extends OptionIdentifier> ids) Creates a copy of this instance without the given option identifiers. Same as `copyWithout(OptionIdentifier...)` but takes an `Iterable<OptionIdentifier>` instead of an `OptionIdentifier[]`. Parameters ids:Iterable<? extends OptionIdentifier> the identifiers to exclude Returns:Options a copy of this instance without the given option identifiers

public Options copyWithout(Iterable<? extends OptionIdentifier> ids)

Creates a copy of this instance without the given option identifiers.

Same as copyWithout(OptionIdentifier...) but takes an Iterable<OptionIdentifier> instead of an OptionIdentifier[].

Parameters

ids:Iterable<? extends OptionIdentifier>: the identifiers to exclude

Returns:Options

a copy of this instance without the given option identifiers

copyWithParent	back to summary
public default Options copyWithParent(Options other)

find	back to summary
public Optional<Object> find(OptionIdentifier id)

find	back to summary
public default Optional<Object> find(WithOptionIdentifier withId)

ids	back to summary
public Set<? extends OptionIdentifier> ids()

of back to summary

of	back to summary
public static Options of(Map<? extends WithOptionIdentifier, Object> map) Creates `Options` instance from the map of objects with option identifiers and associated option values. Parameters map:Map<? extends WithOptionIdentifier, Object> the map of objects with option identifiers and associated option values Returns:Options a new `Options` instance

public static Options of(Map<? extends WithOptionIdentifier, Object> map)

Creates Options instance from the map of objects with option identifiers and associated option values.

Parameters

map:Map<? extends WithOptionIdentifier, Object>: the map of objects with option identifiers and associated option values

Returns:Options

a new Options instance

ofIDs back to summary

ofIDs	back to summary
public static Options ofIDs(Map<OptionIdentifier, Object> map) Creates `Options` instance from the map of option identifiers and associated option values. Similar to `of(Map)` method, but `contains(OptionName)` called on the return instance will always return `false`. Parameters map:Map<OptionIdentifier, Object> the map of option identifiers and associated option values Returns:Options a new `Options` instance

public static Options ofIDs(Map<OptionIdentifier, Object> map)

Creates Options instance from the map of option identifiers and associated option values.

Similar to of(Map) method, but contains(OptionName) called on the return instance will always return false.

Parameters

map:Map<OptionIdentifier, Object>: the map of option identifiers and associated option values

Returns:Options

a new Options instance

toDefaultOptions	back to summary
private static DefaultOptions toDefaultOptions(Options v)

toMap	back to summary
public default Map<OptionIdentifier, Object> toMap() Returns a map representation of this instance. Returns:Map<OptionIdentifier, Object> the map representation of this instance.

toMap

back to summary

public default Map<OptionIdentifier, Object> toMap()

Returns a map representation of this instance.

Returns:Map<OptionIdentifier, Object>: the map representation of this instance.

public sealed Interface Options

Method Summary

Method Detail