Package org.springframework.shell.core.command

Record Class ParsedInput

java.lang.Object

java.lang.Record

org.springframework.shell.core.command.ParsedInput

public record ParsedInput(String commandName, List<String> subCommands, List<CommandOption> options, List<CommandArgument> arguments)
extends Record

Record representing the result of parsing user input into commands.

Since:

4.0.0

Author:

Mahmoud Ben Hassine

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParsedInput.Builder

Constructor Summary

Constructors

Constructor	Description
ParsedInput(String commandName, List<String> subCommands, List<CommandOption> options, List<CommandArgument> arguments)	Creates an instance of a ParsedInput record class.

Method Summary

Modifier and Type	Method	Description
List<CommandArgument>	arguments()	Returns the value of the arguments record component.
static ParsedInput.Builder	builder()
String	commandName()	Returns the value of the commandName 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.
List<CommandOption>	options()	Returns the value of the options record component.
List<String>	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

ParsedInput

public ParsedInput(String commandName,
 List<String> subCommands,
 List<CommandOption> options,
 List<CommandArgument> arguments)

Creates an instance of a ParsedInput record class.

Parameters:

commandName - the value for the commandName record component

subCommands - the value for the subCommands record component

options - the value for the options record component

arguments - the value for the arguments record component

Method Details

builder

public static ParsedInput.Builder builder()

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

commandName

public String commandName()

Returns the value of the commandName record component.

Returns:

the value of the commandName record component

subCommands

public List<String> subCommands()

Returns the value of the subCommands record component.

Returns:

the value of the subCommands record component

options

public List<CommandOption> options()

Returns the value of the options record component.

Returns:

the value of the options record component

arguments

public List<CommandArgument> arguments()

Returns the value of the arguments record component.

Returns:

the value of the arguments record component