Package org.springframework.shell.core.command

Record Class CommandOption

java.lang.Object
java.lang.Record
org.springframework.shell.core.command.CommandOption
public record CommandOption(char shortName, @Nullable String longName, @Nullable String description, @Nullable Boolean required, @Nullable String defaultValue, @Nullable String value) extends Record
Record representing the definition as well as the runtime information about a command option.
Author:
Janne Valkealahti, Piotr Olaszewski, Mahmoud Ben Hassine

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CommandOption.Builder
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommandOption(char shortName, @Nullable String longName, @Nullable String description, @Nullable Boolean required, @Nullable String defaultValue, @Nullable String value)
    Creates an instance of a CommandOption record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    defaultValue()
    Returns the value of the defaultValue record component.
    @Nullable String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @Nullable String
    longName()
    Returns the value of the longName record component.
    @Nullable Boolean
    required()
    Returns the value of the required record component.
    char
    shortName()
    Returns the value of the shortName record component.
    final String
    toString()
    Returns a string representation of this record class.
    @Nullable String
    value()
    Returns the value of the value record component.
    static CommandOption.Builder
    with()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CommandOption

      public CommandOption(char shortName, @Nullable String longName, @Nullable String description, @Nullable Boolean required, @Nullable String defaultValue, @Nullable String value)
      Creates an instance of a CommandOption record class.
      Parameters:
      shortName - the value for the shortName record component
      longName - the value for the longName record component
      description - the value for the description record component
      required - the value for the required record component
      defaultValue - the value for the defaultValue record component
      value - the value for the value record component

  • Method Details

    • with

      public static CommandOption.Builder with()

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

    • shortName

      public char shortName()
      Returns the value of the shortName record component.
      Returns:
      the value of the shortName record component

    • longName

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

    • description

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

    • required

      public @Nullable Boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component

    • defaultValue

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

    • value

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