Package org.springframework.shell.core.command

Record Class ExitStatus

java.lang.Object
java.lang.Record
org.springframework.shell.core.command.ExitStatus
public record ExitStatus(int code, String description) extends Record
Record representing the exit status of a command.
Since:
4.0.0
Author:
Mahmoud Ben Hassine

  • Field Details

    • OK

      public static ExitStatus OK

    • EXECUTION_ERROR

      public static ExitStatus EXECUTION_ERROR

    • USAGE_ERROR

      public static ExitStatus USAGE_ERROR

    • AVAILABILITY_ERROR

      public static ExitStatus AVAILABILITY_ERROR

  • Constructor Details

    • ExitStatus

      public ExitStatus(int code, String description)
      Creates an instance of a ExitStatus record class.
      Parameters:
      code - the value for the code record component
      description - the value for the description 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.

    • code

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

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component