Package org.springframework.shell.command.parser

Record Class Parser.ParseResult

java.lang.Object

java.lang.Record

org.springframework.shell.command.parser.Parser.ParseResult

Record Components:

commandRegistration - command registration

optionResults - option results

argumentResults - argument results

messageResults - message results

directiveResults - directive result

Enclosing interface:

Parser

public static record Parser.ParseResult(CommandRegistration commandRegistration, List<Parser.ParseResult.OptionResult> optionResults, List<Parser.ParseResult.ArgumentResult> argumentResults, List<MessageResult> messageResults, List<DirectiveResult> directiveResults)
extends Record

Results from a Parser containing needed information like resolved CommandRegistration, list of CommandOption instances, errors and directive.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Parser.ParseResult.ArgumentResult
static final record	Parser.ParseResult.OptionResult

Constructor Summary

Constructors

Constructor	Description
ParseResult(CommandRegistration commandRegistration, List<Parser.ParseResult.OptionResult> optionResults, List<Parser.ParseResult.ArgumentResult> argumentResults, List<MessageResult> messageResults, List<DirectiveResult> directiveResults)	Creates an instance of a ParseResult record class.

Method Summary

Modifier and Type	Method	Description
List<Parser.ParseResult.ArgumentResult>	argumentResults()	Returns the value of the argumentResults record component.
CommandRegistration	commandRegistration()	Returns the value of the commandRegistration record component.
List<DirectiveResult>	directiveResults()	Returns the value of the directiveResults 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<MessageResult>	messageResults()	Returns the value of the messageResults record component.
List<Parser.ParseResult.OptionResult>	optionResults()	Returns the value of the optionResults 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

ParseResult

public ParseResult(CommandRegistration commandRegistration,
 List<Parser.ParseResult.OptionResult> optionResults,
 List<Parser.ParseResult.ArgumentResult> argumentResults,
 List<MessageResult> messageResults,
 List<DirectiveResult> directiveResults)

Creates an instance of a ParseResult record class.

Parameters:

commandRegistration - the value for the commandRegistration record component

optionResults - the value for the optionResults record component

argumentResults - the value for the argumentResults record component

messageResults - the value for the messageResults record component

directiveResults - the value for the directiveResults 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. 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.

commandRegistration

public CommandRegistration commandRegistration()

Returns the value of the commandRegistration record component.

Returns:

the value of the commandRegistration record component

optionResults

public List<Parser.ParseResult.OptionResult> optionResults()

Returns the value of the optionResults record component.

Returns:

the value of the optionResults record component

argumentResults

public List<Parser.ParseResult.ArgumentResult> argumentResults()

Returns the value of the argumentResults record component.

Returns:

the value of the argumentResults record component

messageResults

public List<MessageResult> messageResults()

Returns the value of the messageResults record component.

Returns:

the value of the messageResults record component

directiveResults

public List<DirectiveResult> directiveResults()

Returns the value of the directiveResults record component.

Returns:

the value of the directiveResults record component