パッケージ org.springframework.shell.core.command

レコードクラス CommandOption

java.lang.ObjectSE
java.lang.RecordSE
org.springframework.shell.core.command.CommandOption
public record CommandOption(char shortName, @Nullable StringSE longName, @Nullable StringSE description, @Nullable BooleanSE required, @Nullable StringSE defaultValue, @Nullable StringSE value, ClassSE<?> type) extends RecordSE
コマンドオプションの定義と実行時情報を表すレコード。
作成者:
Janne Valkealahti, Piotr Olaszewski, Mahmoud Ben Hassine, David Pilar

  • ネストされたクラスの概要

    ネストされたクラス
    修飾子と型
    クラス
    説明
    static class
    CommandOption.Builder

  • コンストラクター概要

    コンストラクター
    コンストラクター
    説明
    CommandOption(char shortName, @Nullable StringSE longName, @Nullable StringSE description, @Nullable BooleanSE required, @Nullable StringSE defaultValue, @Nullable StringSE value, ClassSE<?> type)
    CommandOption レコードクラスのインスタンスを作成します。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    @Nullable StringSE
    defaultValue()
    defaultValue レコードコンポーネントの値を返します。
    @Nullable StringSE
    description()
    description レコードコンポーネントの値を返します。
    final boolean
    equals(ObjectSE o)
    他のオブジェクトがこのオブジェクトと「等しい」かどうかを示します。
    final int
    hashCode()
    このオブジェクトのハッシュコード値を返します。
    boolean
    isOptionEqual(StringSE optionName)
    @Nullable StringSE
    longName()
    longName レコードコンポーネントの値を返します。
    @Nullable BooleanSE
    required()
    required レコードコンポーネントの値を返します。
    char
    shortName()
    shortName レコードコンポーネントの値を返します。
    final StringSE
    toString()
    このレコードクラスの文字列表現を返します。
    ClassSE<?>
    type()
    type レコードコンポーネントの値を返します。
    @Nullable StringSE
    value()
    value レコードコンポーネントの値を返します。
    static CommandOption.Builder
    with()

    クラス java.lang.ObjectSE から継承されたメソッド

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

  • コンストラクターの詳細

    • CommandOption

      public CommandOption(char shortName, @Nullable StringSE longName, @Nullable StringSE description, @Nullable BooleanSE required, @Nullable StringSE defaultValue, @Nullable StringSE value, ClassSE<?> type)
      CommandOption レコードクラスのインスタンスを作成します。
      パラメーター:
      shortName - shortName レコードコンポーネントの値
      longName - longName レコードコンポーネントの値
      description - description レコードコンポーネントの値
      required - required レコードコンポーネントの値
      defaultValue - defaultValue レコードコンポーネントの値
      value - value レコードコンポーネントの値
      type - type レコードコンポーネントの値

  • メソッドの詳細

    • isOptionEqual

      public boolean isOptionEqual(StringSE optionName)

    • with

      public static CommandOption.Builder with()

    • toString

      public final StringSE toString()
      このレコードクラスの文字列表現を返します。表現には、クラスの名前が含まれ、その後に各レコードコンポーネントの名前と値が続きます。
      次で指定:
      クラス RecordSE の toString 
      戻り値:
      このオブジェクトの文字列表現

    • hashCode

      public final int hashCode()
      このオブジェクトのハッシュコード値を返します。値は、各レコードコンポーネントのハッシュコードから導出されます。
      次で指定:
      クラス RecordSE の hashCode 
      戻り値:
      このオブジェクトのハッシュコード値

    • equals

      public final boolean equals(ObjectSE o)
      他のオブジェクトがこのオブジェクトと「等しい」かどうかを示します。他のオブジェクトが同じクラスであり、すべてのレコードコンポーネントが等しい場合、オブジェクトは等しいです。参照コンポーネントは Objects::equals(Object,Object)SE と比較されます。プリミティブコンポーネントは "==" と比較されます。
      次で指定:
      クラス RecordSE の equalsSE 
      パラメーター:
      o - 比較するオブジェクト
      戻り値:
      このオブジェクトが o 引数と同じ場合は true。それ以外の場合は false。

    • shortName

      public char shortName()
      shortName レコードコンポーネントの値を返します。
      戻り値:
      shortName レコードコンポーネントの値

    • longName

      public @Nullable StringSE longName()
      longName レコードコンポーネントの値を返します。
      戻り値:
      longName レコードコンポーネントの値

    • description

      public @Nullable StringSE description()
      description レコードコンポーネントの値を返します。
      戻り値:
      description レコードコンポーネントの値

    • required

      public @Nullable BooleanSE required()
      required レコードコンポーネントの値を返します。
      戻り値:
      required レコードコンポーネントの値

    • defaultValue

      public @Nullable StringSE defaultValue()
      defaultValue レコードコンポーネントの値を返します。
      戻り値:
      defaultValue レコードコンポーネントの値

    • value

      public @Nullable StringSE value()
      value レコードコンポーネントの値を返します。
      戻り値:
      value レコードコンポーネントの値

    • type

      public ClassSE<?> type()
      type レコードコンポーネントの値を返します。
      戻り値:
      type レコードコンポーネントの値