Package org.pkl.core

Record Class CommandSpec

java.lang.Object

java.lang.Record

org.pkl.core.CommandSpec

public record CommandSpec(String name, @Nullable String helpText, boolean hidden, boolean noOp, Iterable<CommandSpec.Option> options, List<CommandSpec> subcommands, CommandSpec.ApplyFunction apply)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommandSpec.ApplyFunction
static final record	CommandSpec.Argument
static final record	CommandSpec.BooleanFlag
static class	CommandSpec.CompletionCandidates
static final record	CommandSpec.CountedFlag
static final record	CommandSpec.Flag
static interface	CommandSpec.Option
static final record	CommandSpec.Result
static final record	CommandSpec.State

Constructor Summary

Constructors

Constructor	Description
CommandSpec(String name, @Nullable String helpText, boolean hidden, boolean noOp, Iterable<CommandSpec.Option> options, List<CommandSpec> subcommands, CommandSpec.ApplyFunction apply)	Creates an instance of a CommandSpec record class.

Method Summary

Modifier and Type	Method	Description
CommandSpec.ApplyFunction	apply()	Returns the value of the apply record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable String	helpText()	Returns the value of the helpText record component.
boolean	hidden()	Returns the value of the hidden record component.
String	name()	Returns the value of the name record component.
boolean	noOp()	Returns the value of the noOp record component.
Iterable<CommandSpec.Option>	options()	Returns the value of the options record component.
List<CommandSpec>	subcommands()	Returns the value of the subcommands record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CommandSpec

public CommandSpec(String name,
 @Nullable
 @Nullable String helpText,
 boolean hidden,
 boolean noOp,
 Iterable<CommandSpec.Option> options,
 List<CommandSpec> subcommands,
 CommandSpec.ApplyFunction apply)

Creates an instance of a CommandSpec record class.

Parameters:

name - the value for the name record component

helpText - the value for the helpText record component

hidden - the value for the hidden record component

noOp - the value for the noOp record component

options - the value for the options record component

subcommands - the value for the subcommands record component

apply - the value for the apply record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

helpText

@Nullable
public @Nullable String helpText()

Returns the value of the helpText record component.

Returns:

the value of the helpText record component

hidden

public boolean hidden()

Returns the value of the hidden record component.

Returns:

the value of the hidden record component

noOp

public boolean noOp()

Returns the value of the noOp record component.

Returns:

the value of the noOp record component

options

public Iterable<CommandSpec.Option> options()

Returns the value of the options record component.

Returns:

the value of the options record component

subcommands

public List<CommandSpec> subcommands()

Returns the value of the subcommands record component.

Returns:

the value of the subcommands record component

apply

public CommandSpec.ApplyFunction apply()

Returns the value of the apply record component.

Returns:

the value of the apply record component