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

アノテーションインターフェース Option

@RetentionSE(RUNTIMESE) @TargetSE(PARAMETERSE) @DocumentedSE public @interface Option
オプションの候補となるメソッドパラメーターをマークするアノテーション。

  • 要素の詳細

    • longNames

      StringSE[] longNames
      オプションの長い名前。複数の名前が存在する可能性があり、最初の名前がプライマリ名、その他の名前がエイリアスになります。
      戻り値:
      オプションの長い名前。デフォルトは空です。
      デフォルト:
      {}

    • shortNames

      char[] shortNames
      オプションの短い名前。複数の名前が存在する可能性があり、最初の名前がプライマリ名、その他の名前がエイリアスになります。
      戻り値:
      オプションの短縮名。デフォルトは空です。
      デフォルト:
      {}

    • required

      boolean required
      オプションをマークしてください。
      戻り値:
      オプションが必要な場合は true、デフォルトは false。
      デフォルト:
      false

    • defaultValue

      StringSE defaultValue
      オプションのデフォルト値を定義します。
      戻り値:
      デフォルト値
      デフォルト:
      ""

    • description

      StringSE description
      オプションの短い説明を返します。
      戻り値:
      オプションの説明
      デフォルト:
      ""

    • label

      StringSE label
      オプションのラベルを返します。
      戻り値:
      オプションのラベル
      デフォルト:
      ""

    • arity

      CommandRegistration.OptionArity arity
      オプションのアリティを定義します。
      戻り値:
      オプションアリティ
      関連事項:
      デフォルト:
      NONE

    • arityMin

      int arityMin
      オプションの最小値を定義します。定義されている場合は、arity() の代わりに非負が使用されます。arityMax が非負に設定されていない場合は、これと同じに設定されます。
      戻り値:
      オプションアリティ最小値
      関連事項:
      デフォルト:
      -1

    • arityMax

      int arityMax
      オプションの最大アリティを定義します。定義されている場合は、arity() の代わりに非負が使用されます。arityMin が非負に設定されていない場合は、ゼロに設定されます。
      戻り値:
      オプションアリティ最大
      関連事項:
      デフォルト:
      -1