Modifier and Type	Class and Description
pack-priv static class	HelpFormatter.Builder
pack-priv static record	HelpFormatter.ConsoleOptionFormatter
pack-priv static record	HelpFormatter.ConsoleOptionGroupFormatter
pack-priv static interface	HelpFormatter.OptionFormatter
pack-priv static record	HelpFormatter.OptionGroup
pack-priv static interface	HelpFormatter.OptionGroupFormatter

Modifier and Type	Field and Description
private final HelpFormatter.OptionGroupFormatter	formatter
private final List<HelpFormatter.OptionGroup>	optionGroups

Access	Constructor and Description
private	HelpFormatter(List<HelpFormatter.OptionGroup> optionGroups, HelpFormatter.OptionGroupFormatter formatter)

Modifier and Type	Method and Description
pack-priv static HelpFormatter.Builder	build()
pack-priv static Consumer<CharSequence>	eol(Consumer<CharSequence> sink)
pack-priv void	format(Consumer<CharSequence> sink)

formatter	back to summary
private final HelpFormatter.OptionGroupFormatter formatter

optionGroups	back to summary
private final List<HelpFormatter.OptionGroup> optionGroups

HelpFormatter	back to summary
private HelpFormatter(List<HelpFormatter.OptionGroup> optionGroups, HelpFormatter.OptionGroupFormatter formatter)

build	back to summary
pack-priv static HelpFormatter.Builder build()

eol	back to summary
pack-priv static Consumer<CharSequence> eol(Consumer<CharSequence> sink)

format	back to summary
pack-priv void format(Consumer<CharSequence> sink)

jdk.jpackage.internal.cli back to summary

pack-priv final Class HelpFormatter.Builder

Class Inheritance

extends Object

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

Field Summary

Modifier and Type	Field and Description
private HelpFormatter.OptionGroupFormatter	groupFormatter
private final List<HelpFormatter.OptionGroup>	groups

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
pack-priv HelpFormatter	create()
private static HelpFormatter.OptionGroupFormatter	createConsoleFormatter()
pack-priv HelpFormatter.Builder	groupFormatter(HelpFormatter.OptionGroupFormatter v)
pack-priv HelpFormatter.Builder	groups(Collection<HelpFormatter.OptionGroup> v)
pack-priv HelpFormatter.Builder	groups(HelpFormatter.OptionGroup... v)
private HelpFormatter.OptionGroupFormatter	validatedGroupFormatter()

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

Field Detail

groupFormatter	back to summary
private HelpFormatter.OptionGroupFormatter groupFormatter

groups	back to summary
private final List<HelpFormatter.OptionGroup> groups

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

create	back to summary
pack-priv HelpFormatter create()

createConsoleFormatter	back to summary
private static HelpFormatter.OptionGroupFormatter createConsoleFormatter()

groupFormatter	back to summary
pack-priv HelpFormatter.Builder groupFormatter(HelpFormatter.OptionGroupFormatter v)

groups	back to summary
pack-priv HelpFormatter.Builder groups(Collection<HelpFormatter.OptionGroup> v)

groups	back to summary
pack-priv HelpFormatter.Builder groups(HelpFormatter.OptionGroup... v)

validatedGroupFormatter	back to summary
private HelpFormatter.OptionGroupFormatter validatedGroupFormatter()

jdk.jpackage.internal.cli back to summary

pack-priv final Record HelpFormatter.ConsoleOptionFormatter

Class Inheritance

extends Record
implements OptionFormatter

java.lang.Object
java.lang.Record
jdk.jpackage.internal.cli.HelpFormatter.ConsoleOptionFormatter

All Implemented Interfaces

jdk.jpackage.internal.cli.HelpFormatter.OptionFormatter

Record Components

nameOffset:int
descriptionOffset:int

Field Summary

Modifier and Type	Field and Description
private final int	descriptionOffset Record Component accessed by descriptionOffset().
private final int	nameOffset Record Component accessed by nameOffset().

Constructor Summary

Access	Constructor and Description
pack-priv	ConsoleOptionFormatter(int nameOffset, int descriptionOffset)

Method Summary

Modifier and Type	Method and Description
public int	descriptionOffset() Record Component getter of descriptionOffset.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public void	format(String optionNames, Optional<String> valuePattern, String description, Consumer<CharSequence> sink) Implements jdk.jpackage.internal.cli.HelpFormatter.OptionFormatter.format.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public int	nameOffset() Record Component getter of nameOffset.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

descriptionOffset	back to summary
private final int descriptionOffset Record Component accessed by descriptionOffset().

nameOffset	back to summary
private final int nameOffset Record Component accessed by nameOffset().

Constructor Detail

ConsoleOptionFormatter	back to summary
pack-priv ConsoleOptionFormatter(int nameOffset, int descriptionOffset)

Method Detail

descriptionOffset	back to summary
public int descriptionOffset() Record Component getter of descriptionOffset.

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

format	back to summary
public void format(String optionNames, Optional<String> valuePattern, String description, Consumer<CharSequence> sink) Implements jdk.jpackage.internal.cli.HelpFormatter.OptionFormatter.format. Annotations @Override

format

back to summary

public void format(String optionNames, Optional<String> valuePattern, String description, Consumer<CharSequence> sink)

Implements jdk.jpackage.internal.cli.HelpFormatter.OptionFormatter.format.

Annotations

@Override

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.

nameOffset	back to summary
public int nameOffset() Record Component getter of nameOffset.

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.

jdk.jpackage.internal.cli back to summary

pack-priv final Record HelpFormatter.ConsoleOptionGroupFormatter

Class Inheritance

extends Record
implements OptionGroupFormatter

java.lang.Object
java.lang.Record
jdk.jpackage.internal.cli.HelpFormatter.ConsoleOptionGroupFormatter

All Implemented Interfaces

jdk.jpackage.internal.cli.HelpFormatter.OptionGroupFormatter

Record Components

optionFormatter:HelpFormatter.OptionFormatter

Field Summary

Modifier and Type	Field and Description
private final HelpFormatter.OptionFormatter	optionFormatter Record Component accessed by optionFormatter().

Constructor Summary

Access	Constructor and Description
pack-priv	ConsoleOptionGroupFormatter(HelpFormatter.OptionFormatter optionFormatter)

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 void	formatBody(Iterable<? extends OptionSpec<?>> optionSpecs, Consumer<CharSequence> sink) Implements jdk.jpackage.internal.cli.HelpFormatter.OptionGroupFormatter.formatBody.
public void	formatHeader(String groupName, Consumer<CharSequence> sink) Implements jdk.jpackage.internal.cli.HelpFormatter.OptionGroupFormatter.formatHeader.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public HelpFormatter.OptionFormatter	optionFormatter() Record Component getter of optionFormatter.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

optionFormatter	back to summary
private final HelpFormatter.OptionFormatter optionFormatter Record Component accessed by optionFormatter().

Constructor Detail

ConsoleOptionGroupFormatter	back to summary
pack-priv ConsoleOptionGroupFormatter(HelpFormatter.OptionFormatter optionFormatter)

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

formatBody	back to summary
public void formatBody(Iterable<? extends OptionSpec<?>> optionSpecs, Consumer<CharSequence> sink) Implements jdk.jpackage.internal.cli.HelpFormatter.OptionGroupFormatter.formatBody. Annotations @Override

formatBody

back to summary

public void formatBody(Iterable<? extends OptionSpec<?>> optionSpecs, Consumer<CharSequence> sink)

Implements jdk.jpackage.internal.cli.HelpFormatter.OptionGroupFormatter.formatBody.

Annotations

@Override

formatHeader	back to summary
public void formatHeader(String groupName, Consumer<CharSequence> sink) Implements jdk.jpackage.internal.cli.HelpFormatter.OptionGroupFormatter.formatHeader. Annotations @Override

formatHeader

back to summary

public void formatHeader(String groupName, Consumer<CharSequence> sink)

Implements jdk.jpackage.internal.cli.HelpFormatter.OptionGroupFormatter.formatHeader.

Annotations

@Override

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.

optionFormatter	back to summary
public HelpFormatter.OptionFormatter optionFormatter() Record Component getter of optionFormatter.

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.

jdk.jpackage.internal.cli back to summary

pack-priv Interface HelpFormatter.OptionFormatter

Known Direct Implementers: jdk.jpackage.internal.cli.HelpFormatter.ConsoleOptionFormatter

Method Summary

Modifier and Type	Method and Description
public default void	format(OptionSpec<?> optionSpec, Consumer<CharSequence> sink)
public void	format(String optionNames, Optional<String> valuePattern, String description, Consumer<CharSequence> sink)

Method Detail

format	back to summary
public default void format(OptionSpec<?> optionSpec, Consumer<CharSequence> sink)

format	back to summary
public void format(String optionNames, Optional<String> valuePattern, String description, Consumer<CharSequence> sink)

jdk.jpackage.internal.cli back to summary

pack-priv final Record HelpFormatter.OptionGroup

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
jdk.jpackage.internal.cli.HelpFormatter.OptionGroup

Record Components

name:String
options:List<? extends OptionSpec<?>>

Field Summary

Modifier and Type	Field and Description
private final String	name Record Component accessed by name().
private final List<? extends OptionSpec<?>>	options Record Component accessed by options().

Constructor Summary

Access	Constructor and Description
pack-priv	OptionGroup(String name, List<? extends OptionSpec<?>> options)

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 String	name() Record Component getter of name.
public List<? extends OptionSpec<?>>	options() Record Component getter of options.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

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

options	back to summary
private final List<? extends OptionSpec<?>> options Record Component accessed by options().

Constructor Detail

OptionGroup	back to summary
pack-priv OptionGroup(String name, List<? extends OptionSpec<?>> options)

Method Detail

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

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.

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

options	back to summary
public List<? extends OptionSpec<?>> options() Record Component getter of options.

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.

jdk.jpackage.internal.cli back to summary

pack-priv Interface HelpFormatter.OptionGroupFormatter

Known Direct Implementers: jdk.jpackage.internal.cli.HelpFormatter.ConsoleOptionGroupFormatter, jdk.jpackage.internal.cli.StandardHelpFormatter.GroupFormatter, jdk.jpackage.internal.cli.StandardHelpFormatter.SampleGroupFormatter

Method Summary

Modifier and Type	Method and Description
public default void	format(HelpFormatter.OptionGroup group, Consumer<CharSequence> sink)
public void	formatBody(Iterable<? extends OptionSpec<?>> optionSpecs, Consumer<CharSequence> sink)
public void	formatHeader(String gropName, Consumer<CharSequence> sink)

Method Detail

format	back to summary
public default void format(HelpFormatter.OptionGroup group, Consumer<CharSequence> sink)

formatBody	back to summary
public void formatBody(Iterable<? extends OptionSpec<?>> optionSpecs, Consumer<CharSequence> sink)

formatHeader	back to summary
public void formatHeader(String gropName, Consumer<CharSequence> sink)

pack-priv final Class HelpFormatter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class HelpFormatter.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Record HelpFormatter.ConsoleOptionFormatter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Record HelpFormatter.ConsoleOptionGroupFormatter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface HelpFormatter.OptionFormatter

Method Summary

Method Detail

pack-priv final Record HelpFormatter.OptionGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface HelpFormatter.OptionGroupFormatter

Method Summary

Method Detail