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

Record Class ArgsMessage.IllegalValue

java.lang.Object
java.lang.Record
dev.nipafx.args.ArgsMessage.IllegalValue
Record Components:
argumentName - the argument for which the error occurred (which doesn't include "--")
argumentType - the type of the argument
value - the value provided for the argument
parseError - the exception indicates the parse error
All Implemented Interfaces:
ArgsMessage, ArgsMessage.ArgsErrorMessage
Enclosing interface:
ArgsMessage
public static record ArgsMessage.IllegalValue(String argumentName, Class<?> argumentType, String value, Throwable parseError) extends Record implements ArgsMessage.ArgsErrorMessage
Indicates that the value provided for the argument could not be parsed.

  • Constructor Details

    • IllegalValue

      public IllegalValue(String argumentName, Class<?> argumentType, String value, Throwable parseError)
      Creates a message indicating that the value provided for the argument could not be parsed.
      Parameters:
      argumentName - the argument for which the error occurred (which doesn't include "--")
      argumentType - the type of the argument
      value - the value provided for the argument
      parseError - the exception indicates the parse error

  • Method Details

    • toMessage

      public String toMessage()
      Description copied from interface: ArgsMessage
      Returns a textual description of the warning/error that can be shown to the user.
      Specified by:
      toMessage in interface ArgsMessage
      Returns:
      a textual description of the warning/error

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

    • argumentName

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

    • argumentType

      public Class<?> argumentType()
      Returns the value of the argumentType record component.
      Returns:
      the value of the argumentType record component

    • value

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

    • parseError

      public Throwable parseError()
      Returns the value of the parseError record component.
      Returns:
      the value of the parseError record component