インタフェースConnector.Argument

すべてのスーパー・インタフェース:
Serializable
既知のすべてのサブインタフェース:
Connector.BooleanArgument, Connector.IntegerArgument, Connector.SelectedArgument, Connector.StringArgument
含まれているインタフェース:
Connector
public static interface Connector.Argument extends Serializable
Connector引数の仕様と値です。 常に引数のサブインタフェースを実装します(Connector.StringArgument、Connector.BooleanArgument、Connector.IntegerArgument、またはConnector.SelectedArgument)。
導入されたバージョン:
1.3

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    String
    description()
    この引数とその目的について、人間が読むことのできる説明を返します。
    boolean
    isValid(String value)
    引数の基本的な妥当性検査を実行します。
    String
    label()
    この引数の、人間が読むことのできるshort型のラベルを返します。
    boolean
    mustSpecify()
    この引数を指定する必要があるかどうかを示します。
    String
    name()
    この引数のshort型の一意の識別子を返します。
    void
    setValue(String value)
    引数の値を設定します。
    String
    value()
    この引数の現在の値を返します。

  • メソッドの詳細

    • name

      String name()
      この引数のshort型の一意の識別子を返します。 エンド・ユーザーには表示されません。
      戻り値:
      この引数の名前。

    • label

      String label()
      この引数の、人間が読むことのできるshort型のラベルを返します。
      戻り値:
      この引数のラベル

    • description

      String description()
      この引数とその目的について、人間が読むことのできる説明を返します。
      戻り値:
      この引数についての説明

    • value

      String value()
      この引数の現在の値を返します。 最初は、デフォルト値が返されます。 値が現在指定されていない場合は、nullを返します。
      戻り値:
      この引数の現在の値。

    • setValue

      void setValue(String value)
      引数の値を設定します。 この値は、設定する前にisValid(String)でチェックする必要があります。無効な値は、接続が確立されると例外をスローします(たとえば、LaunchingConnector.launch(Map)上)。

    • isValid

      boolean isValid(String value)
      引数の基本的な妥当性検査を実行します。
      戻り値:
      true setValue(String)で使用される際に値が有効な場合

    • mustSpecify

      boolean mustSpecify()
      この引数を指定する必要があるかどうかを示します。 trueの場合、接続を確立する際にこの引数を使用する前に、setValue(String)を使用してnull以外の値を設定する必要があります。
      戻り値:
      この引数を指定する必要がある場合はtrue、それ以外の場合はfalse。