インターフェース CommandOption
- すべての既知の実装クラス:
CommandOption.DefaultCommandOption
public interface CommandOption
コマンドのオプションを表すインターフェース。
ネストされたクラスのサマリー
ネストされたクラスメソッドのサマリー
修飾子と型メソッド説明int
最大アリティを取得します。int
最小アリティを取得します。補完関数を取得します。オプションのデフォルト値を取得します。オプションの説明を取得します。getLabel()
ラベルを取得します。StringSE[]
オプションの長い名前を取得します。StringSE[]
オプションの変更された長い名前を取得します。int
位置値を取得します。オプションの短い名前を取得します。org.springframework.core.ResolvableType
getType()
オプションのResolvableType
を取得します。boolean
オプションが必要な場合にフラグを取得します。static CommandOption
of
(StringSE[] longNames, CharacterSE[] shortNames, StringSE description) デフォルトのCommandOption
のインスタンスを取得します。static CommandOption
of
(StringSE[] longNames, CharacterSE[] shortNames, StringSE description, org.springframework.core.ResolvableType type) デフォルトのCommandOption
のインスタンスを取得します。static CommandOption
of
(StringSE[] longNames, StringSE[] longNamesModified, CharacterSE[] shortNames, StringSE description, org.springframework.core.ResolvableType type, boolean required, StringSE defaultValue, IntegerSE position, IntegerSE arityMin, IntegerSE arityMax, StringSE label, CompletionResolver completion) デフォルトのCommandOption
のインスタンスを取得します。
メソッドの詳細
getLongNames
StringSE[] getLongNames()オプションの長い名前を取得します。- 戻り値:
- オプションの長い名前
getLongNamesModified
StringSE[] getLongNamesModified()オプションの変更された長い名前を取得します。オプション名修飾子が元の名前に関する情報を保持するために使用された場合は、コマンド登録内で設定します。- 戻り値:
- オプションの長い名前を変更しました
getShortNames
CharacterSE[] getShortNames()オプションの短い名前を取得します。- 戻り値:
- オプションの短い名前
getDescription
StringSE getDescription()オプションの説明を取得します。- 戻り値:
- オプションの説明
getType
org.springframework.core.ResolvableType getType()オプションのResolvableType
を取得します。- 戻り値:
- オプションの種類
isRequired
boolean isRequired()オプションが必要な場合にフラグを取得します。- 戻り値:
- 必要なフラグ
getDefaultValue
StringSE getDefaultValue()オプションのデフォルト値を取得します。- 戻り値:
- デフォルト値
getPosition
int getPosition()位置値を取得します。- 戻り値:
- 位置値
getArityMin
int getArityMin()最小アリティを取得します。- 戻り値:
- 最小アリティ
getArityMax
int getArityMax()最大アリティを取得します。- 戻り値:
- 最大アリティ
getLabel
StringSE getLabel()ラベルを取得します。- 戻り値:
- ラベル
getCompletion
CompletionResolver getCompletion()補完関数を取得します。- 戻り値:
- 補完機能
of
デフォルトのCommandOption
のインスタンスを取得します。- パラメーター:
longNames
- 長い名前shortNames
- 短い名前description
- 説明- 戻り値:
- デフォルトのコマンドオプション
of
static CommandOption of(StringSE[] longNames, CharacterSE[] shortNames, StringSE description, org.springframework.core.ResolvableType type) デフォルトのCommandOption
のインスタンスを取得します。- パラメーター:
longNames
- 長い名前shortNames
- 短い名前description
- 説明type
- 型- 戻り値:
- デフォルトのコマンドオプション
of
static CommandOption of(StringSE[] longNames, StringSE[] longNamesModified, CharacterSE[] shortNames, StringSE description, org.springframework.core.ResolvableType type, boolean required, StringSE defaultValue, IntegerSE position, IntegerSE arityMin, IntegerSE arityMax, StringSE label, CompletionResolver completion) デフォルトのCommandOption
のインスタンスを取得します。- パラメーター:
longNames
- 長い名前longNamesModified
- 変更された長い名前shortNames
- 短い名前description
- 説明type
- 型required
- 必要なフラグdefaultValue
- デフォルト値position
- 位置値arityMin
- 最小アリティarityMax
- 最大アリティlabel
- ラベルcompletion
- 完成- 戻り値:
- デフォルトのコマンドオプション