Ant

Description

説明

Runs Ant on a supplied buildfile. This can be used to build subprojects.

与えられたビルドファイルに対し Ant を実行します。 これはサブプロジェクトをビルドするのに使われます。

When the antfile attribute is omitted, the file "build.xml" in the supplied directory (dir attribute) is used.

antfile 属性が省略された場合、 与えられたディレクトリ(dir 属性)にある ファイル"build.xml" が使われます。

If no target attribute is supplied, the default target of the new project is used.

target 属性が与えられなかった場合、 新しいプロジェクトのデフォルトターゲットが使われます。

By default, all of the properties of the current project will be available in the new project. Alternatively, you can set the inheritAll attribute to false and only "user" properties (i.e., those passed on the command-line) will be passed to the new project. In either case, the set of properties passed to the new project will override the properties that are set in the new project (See also the property task).

デフォルトでは、 カレントプロジェクトの全てのプロパティが新しいプロジェクトで利用可能になります。 反対に、 inheritAll属性をfalse に設定して、 "user"プロパティ(即ち、コマンドラインで渡されるもの)のみ 新しいプロジェクトに渡すこともできます。 どちれの場合でも、 新しいプロジェクトに渡されるプロパティの集合は、 新しいプロジェクトで設定されるプロパティで上書きされます。 (property タスクもご覧ください)

You can also set properties in the new project from the old project by using nested property tags. These properties are always passed regardless of the setting of inheritAll. This allows you to parameterize your subprojects.

ネストされた property タグを使って、 古いプロジェクトより、 新しいプロジェクトにおいてプロパティを設定することもできます。 inheritAllの設定に関らず、 これらのプロパティは常に渡されます。 これにより、自分のサブプロジェクトをパラメータ化できます。

References to data types can also be passed to the new project, but by default they are not. If you set the inheritrefs attribute to true, all references will be copied, but they will not override references defined in the new project.

データ型の参照も新しいプロジェクトに渡すことができますが、 デフォルトではできません。 inheritrefs 属性を true に設定した場合、 全ての参照はコピーされます。 しかしながら、新しいプロジェクトで定義された参照を上書きすることはありません。

Nested <reference> elements can also be used to copy references from the calling project to the new project, optionally under a different id. References taken from nested elements will override existing references in the new project.

ネストされた <reference> 要素は、 呼び出し側のプロジェクトから、新しいプロジェクトへ、 オプションとして別の ID で参照をコピーするのにも使われます。 ネストされた要素から得られた参照は、 新しいプロジェクト中の既存の参照を上書きします。

Parameters

パラメータ

Attribute Description Required
antfile the buildfile to use. Defaults to "build.xml". This file is expected to be a filename relative to the dir attribute given. No
dir the directory to use as a basedir for the new Ant project. Defaults to the current project's basedir, unless inheritall has been set to false, in which case it doesn't have a default value. This will override the basedir setting of the called project. No
target the target of the new Ant project that should be executed. Defaults to the new project's default target. No
output Filename to write the ant output to. This is relative to the value of the dir attribute if it has been set or to the base directory of the current project otherwise. No
inheritAll If true, pass all properties to the new Ant project. Defaults to true. No
inheritRefs If true, pass all references to the new Ant project. Defaults to false. No
属性 説明 必須
antfile 使用されるビルドファイル。 デフォルトは "build.xml"。 このファイルは与えられた dir 属性に関連したファイル名であると期待されています。 No
dir 新しい Ant プロジェクトのベースディレクトリとして使うためのディレクトリ。 inheritall が false に設定されなければ、 デフォルトはカレントプロジェクトのベースディレクトリとなります。 設定された場合、デフォルト値はありません。 これは、呼び出されたプロジェクトのベースディレクトリ設定を上書きします。 No
target 実行される新しい Ant プロジェクトのターゲット。 デフォルトは、新しいプロジェクトのデフォルトターゲット No
output Ant の出力を書き出すファイル名。 設定された場合、これは、 dir 属性の値が設定された場合、これに関連した値となり、 設定されなければカレントプロジェクトのベースディレクトリに関連した値となります。 No
inheritAll trueの場合、 全てのプロパティが新しい Ant プロジェクトに渡されます。 デフォルトはtrue No
inheritRefs trueの場合、 全ての参照が新しい Ant プロジェクトに渡されます。 デフォルトはfalse No

Parameters specified as nested elements

ネストされる要素として指定されるパラメータ

property

See the description of the property task. Note that the refid attribute points to a reference in the calling project, not in the new one.

property タスクの説明をご覧ください。 refid属性が、 新しいプロジェクトではなく、 呼び出し側のプロジェクトを参照を指すことに注意してください。

reference

Used to chose references that shall be copied into the new project, optionally changing their id.

オプションとして、そのIDを変えながら、 新しいプロジェクトにコピーされる参照を選択するのに使われます。

Attribute Description Required
refid The id of the reference in the calling project. Yes
torefid The id of the reference in the new project. No, defaults to the value of refid.
属性 説明 必須
refid 呼び出し側のプロジェクトの参照のID Yes
torefid 新しいプロジェクトの参照のID No、デフォルトは refid の値

Basedir of the new project

新しいプロジェクトのベースディレクトリ

The basedir value of the new project is affected by the two attributes dir and inheritall, see the following table for details:

新しいプロジェクトのbasedir の値は、 dir と inheritall の 2 つの属性に影響します。 詳しくは次の表をご覧ください:

dir attribute inheritAll attribute new project's basedir
value provided true value of dir attribute
value provided false value of dir attribute
omitted true basedir of calling project (the one whose build file contains the <ant> task).
omitted false basedir attribute of the <project> element of the new project
dir 属性 inheritAll 属性 新しいプロジェクトのbasedir
値を指定 true dir属性の値
値を指定 false dir属性の値
省略 true 呼び出し側プロジェクトの basedir( ビルドファイルに<ant>タスクがあるもの)
省略 false 新しいプロジェクトの<project> 要素の basedir 属性

Examples

  <ant antfile="subproject/subbuild.xml" dir="subproject" target="compile"/>

  <ant dir="subproject"/>

  <ant antfile="subproject/property_based_subbuild.xml">
    <property name="param1" value="version 1.x"/>
    <property file="config/subproject/default.properties"/>
  </ant>

  <ant inheritAll="false" antfile="subproject/subbuild.xml">
    <property name="output.type" value="html"/>
  </ant>

The build file of the calling project defines some <path> elements like this:

呼び出し側プロジェクトのビルドファイルは、 いくつかの<path>要素を次のように定義します:

  <path id="path1">
    ...
  </>
  <path id="path2">
    ...
  </>

and the called build file (subbuild.xml) also defines a <path> with the id path1, but path2 is not defined:

そして、呼び出されたビルドファイル(subbuild.xml)もまた、 ID path1 をつけて <path> を定義します。 しかし、path2は定義されません:

  <ant antfile="subbuild.xml" inheritrefs="true" />

will not override subbuild's definition of path1, but make the parent's definition of path2 available in the subbuild.

これはpath1subbuildの定義を上書きしませんが、 subbuild において、親のpath2の定義が利用可能です。

  <ant antfile="subbuild.xml" />

as well as

同様に

  <ant antfile="subbuild.xml" inheritrefs="false" />

will neither override path1 nor copy path2.

では、path1 を上書きせず、 path2 をコピーもしません。

  <ant antfile="subbuild.xml" inheritrefs="false" >
    <reference refid="path1" />
  </ant>

will override subbuild's definition of path1.

これはsubbuildpath1の定義を上書きします。

  <ant antfile="subbuild.xml" inheritrefs="false" >
    <reference refid="path1" torefid="path2" />
  </ant>

will copy the parent's definition of path1 into the new project using the id path2.

これは親のpath1の定義を、 ID path2を用いて新しいプロジェクトにコピーします。


Copyright © 2000-2002 Apache Software Foundation. All rights Reserved.

[訳注:これは漆島賢二が翻訳しました。日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]