Package io.github.wankdanker.clyops

Record Class ParseResult

java.lang.Object
java.lang.Record
io.github.wankdanker.clyops.ParseResult
public record ParseResult(String status, String error, boolean showUsage, List<String> detail) extends Record
The outcome of Cli.parse(java.lang.String...): status is "ok", "help" or "error".

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParseResult(String status, String error, boolean showUsage, List<String> detail)
    Creates an instance of a ParseResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    detail()
    Returns the value of the detail record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    error()
    Returns the value of the error record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    showUsage()
    Returns the value of the showUsage record component.
    String
    status()
    Returns the value of the status 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(String status, String error, boolean showUsage, List<String> detail)
      Creates an instance of a ParseResult record class.
      Parameters:
      status - the value for the status record component
      error - the value for the error record component
      showUsage - the value for the showUsage record component
      detail - the value for the detail 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.

    • status

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

    • error

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

    • showUsage

      public boolean showUsage()
      Returns the value of the showUsage record component.
      Returns:
      the value of the showUsage record component

    • detail

      public List<String> detail()
      Returns the value of the detail record component.
      Returns:
      the value of the detail record component