Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Validator.Builder<T, U extends Exception>
public static class	Validator.Details
public static interface	Validator.ParsedValue<T>
public static class	Validator.ValidatingConsumerException Thrown to indicate that the given value didn't pass validation.
public static class	Validator.ValidatorException Thrown to indicate an error in the normal execution of a validator.

Method Summary

Modifier and Type	Method and Description
public default Validator<T, ? extends Exception>	andGreedy(Validator<T, ? extends Exception> after)
public static <T, U extends Exception> Validator<T, U>	andGreedy(Validator<T, U> first, Validator<T, U> second)
public default Validator<T, ? extends Exception>	andLazy(Validator<T, ? extends Exception> after)
public static <T, U extends Exception> Validator<T, U>	andLazy(Validator<T, U> first, Validator<T, U> second)
public static <T, U extends Exception> Validator.Builder<T, U>	build()
public default Validator<T, ? extends Exception>	or(Validator<T, ? extends Exception> after)
public static <T, U extends Exception> Validator<T, U>	or(Validator<T, U> first, Validator<T, U> second)
public List<U>	Returns: the list of validation errors validate(OptionName the name of an option to validate optionName, Validator.ParsedValue<T> the value of an option to validate optionValue) Validates the given option value.

Method Detail

andGreedy	back to summary
public default Validator<T, ? extends Exception> andGreedy(Validator<T, ? extends Exception> after)

andGreedy	back to summary
public static <T, U extends Exception> Validator<T, U> andGreedy(Validator<T, U> first, Validator<T, U> second) Annotations @SuppressWarnings:unchecked

andLazy	back to summary
public default Validator<T, ? extends Exception> andLazy(Validator<T, ? extends Exception> after)

andLazy	back to summary
public static <T, U extends Exception> Validator<T, U> andLazy(Validator<T, U> first, Validator<T, U> second) Annotations @SuppressWarnings:unchecked

build	back to summary
public static <T, U extends Exception> Validator.Builder<T, U> build()

or	back to summary
public default Validator<T, ? extends Exception> or(Validator<T, ? extends Exception> after)

or	back to summary
public static <T, U extends Exception> Validator<T, U> or(Validator<T, U> first, Validator<T, U> second) Annotations @SuppressWarnings:unchecked

validate	back to summary
public List<U> validate(OptionName optionName, Validator.ParsedValue<T> optionValue) throws ValidatorException Validates the given option value. Parameters optionName:OptionName the name of an option to validate optionValue:Validator.ParsedValue<T> the value of an option to validate Returns:List<U> the list of validation errors Exceptions ValidatorException: if internal validator error occurs

validate

back to summary

public List<U> validate(OptionName optionName, Validator.ParsedValue<T> optionValue) throws ValidatorException

Validates the given option value.

Parameters

optionName:OptionName: the name of an option to validate
optionValue:Validator.ParsedValue<T>: the value of an option to validate

Returns:List<U>

the list of validation errors

Exceptions

ValidatorException:: if internal validator error occurs

jdk.jpackage.internal.cli back to summary

public final Class Validator.Builder<T, U extends Exception>

Class Inheritance

extends Object

java.lang.Object
jdk.jpackage.internal.cli.Validator.Builder

Field Summary

Modifier and Type	Field and Description
private Consumer<T>	consumer
private OptionValueExceptionFactory<? extends U>	exceptionFactory
private String	formatString
private Predicate<T>	predicate

Constructor Summary

Access	Constructor and Description
private	Builder()
pack-priv	Builder(Validator.Builder<T, U> other)

Method Summary

Modifier and Type	Method and Description
pack-priv Validator.Builder<T, U>	consumer(Consumer<T> v)
pack-priv Optional<Consumer<T>>	consumer()
pack-priv Validator.Builder<T, U>	copy()
pack-priv Validator<T, U>	create()
pack-priv Validator.Builder<T, U>	exceptionFactory(OptionValueExceptionFactory<? extends U> v)
pack-priv Optional<OptionValueExceptionFactory<? extends U>>	exceptionFactory()
pack-priv Validator.Builder<T, U>	formatString(String v)
pack-priv Optional<String>	formatString()
pack-priv boolean	hasValidatingMethod()
pack-priv Validator.Builder<T, U>	mutate(Consumer<Validator.Builder<T, U>> mutator)
pack-priv Validator.Builder<T, U>	predicate(Predicate<T> v)
pack-priv Optional<Predicate<T>>	predicate()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

consumer	back to summary
private Consumer<T> consumer

exceptionFactory	back to summary
private OptionValueExceptionFactory<? extends U> exceptionFactory

formatString	back to summary
private String formatString

predicate	back to summary
private Predicate<T> predicate

Constructor Detail

Builder	back to summary
private Builder()

Builder	back to summary
pack-priv Builder(Validator.Builder<T, U> other)

Method Detail

consumer	back to summary
pack-priv Validator.Builder<T, U> consumer(Consumer<T> v)

consumer	back to summary
pack-priv Optional<Consumer<T>> consumer()

copy	back to summary
pack-priv Validator.Builder<T, U> copy()

create	back to summary
pack-priv Validator<T, U> create()

exceptionFactory	back to summary
pack-priv Validator.Builder<T, U> exceptionFactory(OptionValueExceptionFactory<? extends U> v)

exceptionFactory	back to summary
pack-priv Optional<OptionValueExceptionFactory<? extends U>> exceptionFactory()

formatString	back to summary
pack-priv Validator.Builder<T, U> formatString(String v)

formatString	back to summary
pack-priv Optional<String> formatString()

hasValidatingMethod	back to summary
pack-priv boolean hasValidatingMethod()

mutate	back to summary
pack-priv Validator.Builder<T, U> mutate(Consumer<Validator.Builder<T, U>> mutator)

predicate	back to summary
pack-priv Validator.Builder<T, U> predicate(Predicate<T> v)

predicate	back to summary
pack-priv Optional<Predicate<T>> predicate()

jdk.jpackage.internal.cli back to summary

public final Class Validator.Details

Class Inheritance

extends Object

java.lang.Object
jdk.jpackage.internal.cli.Validator.Details

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static record	Validator.Details.DefaultParsedValue<T>
private static record	Validator.Details.ScalarValidator<T, U extends Exception>

Constructor Summary

Access	Constructor and Description
private	Details()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Details	back to summary
private Details()

jdk.jpackage.internal.cli back to summary

private final Record Validator.Details.DefaultParsedValue<T>

Class Inheritance

extends Record
implements Validator.ParsedValue<T>

java.lang.Object
java.lang.Record
jdk.jpackage.internal.cli.Validator.Details.DefaultParsedValue

All Implemented Interfaces

jdk.jpackage.internal.cli.Validator.ParsedValue

Record Components

value:T
sourceToken:StringToken

Field Summary

Modifier and Type	Field and Description
private final StringToken	sourceToken Record Component accessed by sourceToken().
private final T	value Record Component accessed by value().

Constructor Summary

Access	Constructor and Description
pack-priv	DefaultParsedValue(T value, StringToken sourceToken)

Method Summary

Modifier and Type	Method 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 StringToken	sourceToken() Record Component getter of sourceToken. Implements jdk.jpackage.internal.cli.Validator.ParsedValue.sourceToken.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public T	value() Record Component getter of value. Implements jdk.jpackage.internal.cli.Validator.ParsedValue.value.

Field Detail

sourceToken	back to summary
private final StringToken sourceToken Record Component accessed by sourceToken().

value	back to summary
private final T value Record Component accessed by value().

Constructor Detail

DefaultParsedValue	back to summary
pack-priv DefaultParsedValue(T value, StringToken sourceToken)

Method Detail

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

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.

sourceToken	back to summary
public StringToken sourceToken() Record Component getter of sourceToken. Implements jdk.jpackage.internal.cli.Validator.ParsedValue.sourceToken.

sourceToken

back to summary

public StringToken sourceToken()

Record Component getter of sourceToken.

Implements jdk.jpackage.internal.cli.Validator.ParsedValue.sourceToken.

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.

value	back to summary
public T value() Record Component getter of value. Implements jdk.jpackage.internal.cli.Validator.ParsedValue.value.

value

back to summary

public T value()

Record Component getter of value.

Implements jdk.jpackage.internal.cli.Validator.ParsedValue.value.

jdk.jpackage.internal.cli back to summary

private final Record Validator.Details.ScalarValidator<T, U extends Exception>

Class Inheritance

extends Record
implements Validator<T, U extends Exception>

java.lang.Object
java.lang.Record
jdk.jpackage.internal.cli.Validator.Details.ScalarValidator

All Implemented Interfaces

jdk.jpackage.internal.cli.Validator

Record Components

predicate:Optional<Predicate<T>>
consumer:Optional<Consumer<T>>
formatString:String
exceptionFactory:OptionValueExceptionFactory<? extends U>

Field Summary

Modifier and Type	Field and Description
private final Optional<Consumer<T>>	consumer Record Component accessed by consumer().
private final OptionValueExceptionFactory<? extends U>	exceptionFactory Record Component accessed by exceptionFactory().
private final String	formatString Record Component accessed by formatString().
private final Optional<Predicate<T>>	predicate Record Component accessed by predicate().

Constructor Summary

Access	Constructor and Description
pack-priv	ScalarValidator(Optional<Predicate<T>> predicate, Optional<Consumer<T>> consumer, String formatString, OptionValueExceptionFactory<? extends U> exceptionFactory)

Method Summary

Modifier and Type	Method and Description
public Optional<Consumer<T>>	consumer() Record Component getter of consumer.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public OptionValueExceptionFactory<? extends U>	exceptionFactory() Record Component getter of exceptionFactory.
public String	formatString() Record Component getter of formatString.
private List<U>	handleException(OptionName optionName, Validator.ParsedValue<T> optionValue, RuntimeException ex)
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public Optional<Predicate<T>>	predicate() Record Component getter of predicate.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public List<U>	validate(OptionName optionName, Validator.ParsedValue<T> optionValue) Implements jdk.jpackage.internal.cli.Validator.validate. Validates the given option value.

Field Detail

consumer	back to summary
private final Optional<Consumer<T>> consumer Record Component accessed by consumer().

exceptionFactory	back to summary
private final OptionValueExceptionFactory<? extends U> exceptionFactory Record Component accessed by exceptionFactory().

formatString	back to summary
private final String formatString Record Component accessed by formatString().

predicate	back to summary
private final Optional<Predicate<T>> predicate Record Component accessed by predicate().

Constructor Detail

ScalarValidator	back to summary
pack-priv ScalarValidator(Optional<Predicate<T>> predicate, Optional<Consumer<T>> consumer, String formatString, OptionValueExceptionFactory<? extends U> exceptionFactory)

Method Detail

consumer	back to summary
public Optional<Consumer<T>> consumer() Record Component getter of consumer.

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

exceptionFactory	back to summary
public OptionValueExceptionFactory<? extends U> exceptionFactory() Record Component getter of exceptionFactory.

formatString	back to summary
public String formatString() Record Component getter of formatString.

handleException	back to summary
private List<U> handleException(OptionName optionName, Validator.ParsedValue<T> optionValue, RuntimeException ex)

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

predicate	back to summary
public Optional<Predicate<T>> predicate() Record Component getter of predicate.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

validate

back to summary

public List<U> validate(OptionName optionName, Validator.ParsedValue<T> optionValue)

Implements jdk.jpackage.internal.cli.Validator.validate.

Doc from jdk.jpackage.internal.cli.Validator.validate.

Validates the given option value.

Annotations

@Override

jdk.jpackage.internal.cli back to summary

public sealed Interface Validator.ParsedValue<T>

Known Direct Implementers: jdk.jpackage.internal.cli.Validator.Details.DefaultParsedValue

Method Summary

Modifier and Type	Method and Description
public static <T> Validator.ParsedValue<T>	create(T value, StringToken sourceToken)
public StringToken	sourceToken()
public T	value()

Method Detail

create	back to summary
public static <T> Validator.ParsedValue<T> create(T value, StringToken sourceToken)

sourceToken	back to summary
public StringToken sourceToken()

value	back to summary
public T value()

jdk.jpackage.internal.cli back to summary

public final Class Validator.ValidatingConsumerException

Class Inheritance

extends RuntimeException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
jdk.jpackage.internal.cli.Validator.ValidatingConsumerException

Thrown to indicate that the given value didn't pass validation.

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.lang.RuntimeException.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	ValidatingConsumerException(String msg, Exception cause)
pack-priv	ValidatingConsumerException(Throwable cause)

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.RuntimeException.serialVersionUID.

Constructor Detail

ValidatingConsumerException	back to summary
pack-priv ValidatingConsumerException(String msg, Exception cause)

ValidatingConsumerException	back to summary
pack-priv ValidatingConsumerException(Throwable cause)

jdk.jpackage.internal.cli back to summary

public final Class Validator.ValidatorException

Class Inheritance

extends RuntimeException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
jdk.jpackage.internal.cli.Validator.ValidatorException

Thrown to indicate an error in the normal execution of a validator.

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.lang.RuntimeException.serialVersionUID.

Constructor Summary

Access	Constructor and Description
private	ValidatorException(Exception cause)

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.RuntimeException.serialVersionUID.

Constructor Detail

ValidatorException	back to summary
private ValidatorException(Exception cause)

pack-priv Interface Validator<T, U extends Exception>

Nested and Inner Type Summary

Method Summary

Method Detail

public final Class Validator.Builder<T, U extends Exception>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Validator.Details

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

private final Record Validator.Details.DefaultParsedValue<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record Validator.Details.ScalarValidator<T, U extends Exception>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public sealed Interface Validator.ParsedValue<T>

Method Summary

Method Detail

public final Class Validator.ValidatingConsumerException

Field Summary

Constructor Summary

Field Detail

Constructor Detail

public final Class Validator.ValidatorException

Field Summary

Constructor Summary

Field Detail

Constructor Detail