Module com.github.sormuras.bach
Package com.github.sormuras.bach

Record Class Options.MainOptions

java.lang.Object
java.lang.Record
com.github.sormuras.bach.Options.MainOptions
Enclosing class:
Options
public static record Options.MainOptions(Optional<Boolean> help, Optional<Boolean> listTools, Optional<String> runTool, Optional<Boolean> showTools, Optional<Boolean> version) extends Record
A group of optional components used by the main program.

  • Constructor Details

    • MainOptions

      public MainOptions(Optional<Boolean> help, Optional<Boolean> listTools, Optional<String> runTool, Optional<Boolean> showTools, Optional<Boolean> version)
      Creates an instance of a MainOptions record class.
      Parameters:
      help - the value for the help record component
      listTools - the value for the listTools record component
      runTool - the value for the runTool record component
      showTools - the value for the showTools record component
      version - the value for the version 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. 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.

    • help

      public Optional<Boolean> help()
      Returns the value of the help record component.
      Returns:
      the value of the help record component

    • listTools

      public Optional<Boolean> listTools()
      Returns the value of the listTools record component.
      Returns:
      the value of the listTools record component

    • runTool

      public Optional<String> runTool()
      Returns the value of the runTool record component.
      Returns:
      the value of the runTool record component

    • showTools

      public Optional<Boolean> showTools()
      Returns the value of the showTools record component.
      Returns:
      the value of the showTools record component

    • version

      public Optional<Boolean> version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component