Module dev.nipafx.args
Package dev.nipafx.args

Record Class ArgsMessage

java.lang.Object
java.lang.Record
dev.nipafx.args.ArgsMessage
Record Components:
code - the warning/error code for this message
message - a textual description of the warning/error
cause - the Throwable that caused the error (if available)
public record ArgsMessage(ArgsParseErrorCode code, String message, Optional<Throwable> cause) extends Record
A warning or error that occurred while parsing command line arguments.

  • Constructor Details

    • ArgsMessage

      public ArgsMessage(ArgsParseErrorCode code, String message, Optional<Throwable> cause)
      Creates an instance of a ArgsMessage record class.
      Parameters:
      code - the value for the code record component
      message - the value for the message record component
      cause - the value for the cause record component

  • Method Details

    • toString

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

    • code

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

    • message

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

    • cause

      public Optional<Throwable> cause()
      Returns the value of the cause record component.
      Returns:
      the value of the cause record component