Input

Description

説明

Allows user interaction during the build process by prompting for input. To do so, it uses the configured InputHandler.

ビルド中、入力プロンプトを表示してユーザの入力を受け付けます。 入力を受け取るために、InputHandlerを利用します。

The prompt can be set via the message attribute or as character data nested into the element.

message属性、またはネストされた文字データで入力プロンプトを設定できます。

Optinonally a set of valid imput arguments can be defined via the validargs attribute. Input task will no accept value that don't match one of the predefined.

validargs 属性を使うと、入力の有効値を定義することができます。 入力された値が、あらかじめ定義された値のどれかに一致しない場合は、 値を受け付けません(もう一度プロンプトを表示します)。

Optionally a property can be created from the value entered by the user. This property can then be used during the following build run. Input behaves according to property task which means that existing properties cannot be overriden. Since Ant 1.6, <input> will not prompt for input if a property should be set by the task that has already been set in the project (and the task wouldn't have any effect).

ユーザからの入力値を保持するプロパティを生成することができます。 このプロパティは、それ以降のビルド過程で利用することができます。 inputタスクは propertyタスクと同じように動作します。 すなわち、既存のプロパティを上書きすることはできません。 Ant 1.6 からは、 プロパティがすでにセットされていた場合、 <input>は入力プロンプトを出さず、なにも変更しません。

Parameters

パラメータ

Attribute Description Required
message the Message which gets displayed to the user during the build run. No
validargs comma separated String containing valid input arguments. If set, input task will reject any input not defined here. Validargs are compared case sensitive. If you want 'a' and 'A' to be accepted you will need to define both arguments within validargs. No
addproperty the name of a property to be created from input. Behaviour is equal to property task which means that existing properties cannot be overriden. No
defaultvalue Defines the default value of the property to be created from input. Property value will be set to default if no input is received. No
属性 説明 必須
message ビルド中にユーザに表示されるメッセージ文字列 いいえ
validargs 入力として有効な値。カンマ区切りの文字列。 設定されている場合、ここで定義した値以外の入力は拒否される。 大文字と小文字は区別される。'a'と'A'を受け付けたい場合、両方を記述しておく必要がある。 いいえ
addproperty 入力された値を持つ、新たに生成されるプロパティの名前。 挙動はpropertyタスクと同様。すなわち既存プロパティは上書きできない。 いいえ
defaultvalue 入力が空だったときの、プロパティの既定値。 いいえ

Examples

  <input/>

Will pause the build run until return key is pressed when using the default InputHandler, the concrete behavior is defined by the InputHandler implementation you use.

リターンキーが押されるまで一時停止します (デフォルトのInputHandlerを使っている場合)。 実際の挙動は、使用する InputHandler の実装によって決まります。

  <input>Press Return key to continue...</input>
  <input>続けるにはリターンキーを押してください...</input>

Will display the message "Press Return key to continue..." and pause the build run until return key is pressed (again, the concrete behavior is implementation dependent).

「続けるにはリターンキーを押してください...」というメッセージを表示し、 リターンキーが押されるまで一時停止します (繰り返しになりますが、実際の振舞いは実装依存です)。

  <input
    message="Press Return key to continue..."
  />
  <input
    message="続けるにはリターンキーを押してください..."
  />

Will display the message "Press Return key to continue..." and pause the build run until return key is pressed (see above).

「続けるにはリターンキーを押してください...」というメッセージを表示し、 リターンキーが押されるまで一時停止します (上を参照) 。

  <input
    message="All data is going to be deleted from DB continue (y/n)?"
    validargs="y,n"
    addproperty="do.delete"
  />
  <condition property="do.abort">
    <equals arg1="n" arg2="${do.delete}"/>
  </condition>
  <fail if="do.abort">Build aborted by user.</fail>
  <input
    message="全てのデータがDBから削除されます。続けますか(y/n)?"
    validargs="y,n"
    addproperty="do.delete"
  />
  <condition property="do.abort">
    <equals arg1="n" arg2="${do.delete}"/>
  </condition>
  <fail if="do.abort">ユーザによりビルドは中断されました</fail>

Will display the message "All data is going to be deleted from DB continue (y/n)?" and require 'y' to continue build or 'n' to exit build with following message "Build aborted by user.".

「全てのデータがDBから削除されます。続けますか(y/n)?」 というメッセージを表示し、'y'ならばビルドを継続しますが、'n' ならば、 「ユーザによりビルドは中断されました」というメッセージを表示して、 ビルドを終了します。

  <input
    message="Please enter db-username:"
    addproperty="db.user"
  />
  <input
    message="データベースのユーザ名を入力してください:"
    addproperty="db.user"
  />

Will display the message "Please enter db-username:" and set the property db.user to the value entered by the user.

「データベースのユーザ名を入力してください:」というメッセージを表示し、 ユーザが入力した値を db.userプロパティに設定します。

  <input
    message="Please enter db-username:"
    addproperty="db.user"
    defaultvalue="Scott-Tiger"
  />
  <input
    message="データベースのユーザ名を入力してください:"
    addproperty="db.user"
    defaultvalue="Scott-Tiger"
  />

Same as above, but will set db.user to the value Scott- Tiger if the user enters no value (simply types <return>).

上と同じですが、入力が無かった(<リターン>だけを入力した)場合、 db.userには Scott-Tiger が設定されます。


Copyright © 2001-2004 The Apache Software Foundation. All rights Reserved.
日本語訳の著作権は、Ja-Jakartaプロジェクトが保有します。 Copyright © 2004 Ja-Jakarta project. All rights Reserved.
[訳注:これは漆島賢二の訳を参考に、的場が翻訳しました。日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]