Package org.springframework.shell.command.parser

Record Class MessageResult

java.lang.Object
java.lang.Record
org.springframework.shell.command.parser.MessageResult
public record MessageResult(ParserMessage parserMessage, int position, Object[] inserts) extends Record
Encapsulating ParserMessage with position and inserts.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MessageResult(ParserMessage parserMessage, int position, Object[] inserts)
    Creates an instance of a MessageResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    getMessage()
    Gets a formatted message using position and inserts.
    final int
    hashCode()
    Returns a hash code value for this object.
    Object[]
    inserts()
    Returns the value of the inserts record component.
    static MessageResult
    of(ParserMessage parserMessage, int position, Object... inserts)
    Constructs MessageResult with parser message, position and inserts.
    ParserMessage
    parserMessage()
    Returns the value of the parserMessage record component.
    int
    position()
    Returns the value of the position 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

    • MessageResult

      public MessageResult(ParserMessage parserMessage, int position, Object[] inserts)
      Creates an instance of a MessageResult record class.
      Parameters:
      parserMessage - the value for the parserMessage record component
      position - the value for the position record component
      inserts - the value for the inserts record component

  • Method Details

    • of

      public static MessageResult of(ParserMessage parserMessage, int position, Object... inserts)
      Constructs MessageResult with parser message, position and inserts.
      Parameters:
      parserMessage - the parser message
      position - the position
      inserts - the inserts
      Returns:
      a message result

    • getMessage

      public String getMessage()
      Gets a formatted message using position and inserts.
      Returns:
      a formatted message

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

    • parserMessage

      public ParserMessage parserMessage()
      Returns the value of the parserMessage record component.
      Returns:
      the value of the parserMessage record component

    • position

      public int position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component

    • inserts

      public Object[] inserts()
      Returns the value of the inserts record component.
      Returns:
      the value of the inserts record component