Package net.royalur.cli

Record Class CLIArgument

java.lang.Object
java.lang.Record
net.royalur.cli.CLIArgument
public record CLIArgument(String name, CLIArgumentType type, String[] descriptionLines, boolean required) extends Record

  • Constructor Details

    • CLIArgument

      public CLIArgument(String name, CLIArgumentType type, String[] descriptionLines, boolean required)
      Creates an instance of a CLIArgument record class.
      Parameters:
      name - the value for the name record component
      type - the value for the type record component
      descriptionLines - the value for the descriptionLines record component
      required - the value for the required record component

  • Method Details

    • isKeywordArg

      public boolean isKeywordArg()

    • isPositionalArg

      public boolean isPositionalArg()

    • getNameAndType

      public String getNameAndType()

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

    • name

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

    • type

      public CLIArgumentType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • descriptionLines

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

    • required

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