Record Class ArgumentParser.Argument

java.lang.Object
java.lang.Record
opennlp.tools.cmdline.ArgumentParser.Argument
Enclosing class:
ArgumentParser

static record ArgumentParser.Argument(String argument, String value, String description, boolean optional) extends Record
Auxiliary record that holds information about an argument. This is used by the GenerateManualTool, which creates a Docbook for the CLI automatically.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final String
    The field for the argument record component.
    private final String
    The field for the description record component.
    private final boolean
    The field for the optional record component.
    private final String
    The field for the value record component.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Argument(String argument, String value, String description, boolean optional)
    Creates an instance of a Argument record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the argument record component.
    Returns the value of the description record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    boolean
    Returns the value of the optional record component.
    final String
    Returns a string representation of this record class.
    Returns the value of the value record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • argument

      private final String argument
      The field for the argument record component.
    • value

      private final String value
      The field for the value record component.
    • description

      private final String description
      The field for the description record component.
    • optional

      private final boolean optional
      The field for the optional record component.
  • Constructor Details

    • Argument

      Argument(String argument, String value, String description, boolean optional)
      Creates an instance of a Argument record class.
      Parameters:
      argument - the value for the argument record component
      value - the value for the value record component
      description - the value for the description record component
      optional - the value for the optional 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 the compare method from their corresponding wrapper classes.
      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.
    • argument

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

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

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

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