Import

Description

説明

Imports another build file into the current project.

現在のプロジェクトに、他のビルドファイルをインポートします。

On execution it will read another Ant file into the same Project. This means that it basically works like the Entity Includes as explained in the Ant FAQ, as if the imported file was contained in the importing file, minus the top <project> tag.

実行時、別のAntファイルを同一のプロジェクトに読み込みます。
基本的には、 Ant FAQの、Entity Includeの項における、 インポートしたいファイルからトップの<project>タグを除いたものを、 インポートするファイルに含めたときのように動作します。

The import task may only be used as a top-level task. This means that it may not be used in a target.

importタスクはトップレベルだけで使用できます。ターゲットの中では使えません。

There are two further functional aspects that pertain to this task and that are not possible with entity includes:

このタスクには、Entity Include の場合とは異なる、二つの特徴的な機能が備わっています。

Target overriding

ターゲットのオーバライド

If a target in the main file is also present in at least one of the imported files, it takes precedence.

インポートされるファイルにあるターゲットと同じターゲットが元ファイルにある場合、 元ファイルのターゲットが優先されます。

So if I import for example a docsbuild.xml file named builddocs, that contains a "docs" target, I can redefine it in my main buildfile and that is the one that will be called. It makes it easy to keep the same target name, that has the same dependencies (so it is still called by the other targets), but use a different implementation.

docsbuild.xmlという、builddocsと名づけられたファイルをインポートする際、 そのファイルにdocsというターゲットがある場合、インポートする側のビルドファイルで、 そのターゲットを再定義することができます。 同じターゲット名、同じ依存関係であるが、別の実装を使いたい、ということが容易となります。

The original target is still available though, and is called "builddocs.docs". This means that in my new implementation, I can still call the old target, making it possible to enhance it with tasks called before or after it.

このときでも、オリジナルのターゲットは、"builddocs.docs"という名前で呼び出すことができます。 これはつまり、タスクの新しい実装の中からオリジナルのターゲットを呼び出すことができるわけで、 オリジナルのターゲットの前や後に動作を追加することができるということです。

Special Properties

特別なプロパティ

Imported files are treated as they are present in the main buildfile. This makes it easy to understand, but it makes it impossible for them to reference files and resources relative to their path. Because of this, for every imported file, Ant adds a property that contains the path to the imported buildfile. With this path, the imported buildfile can keep resources and be able to reference them relative to its position.

インポートされるファイルは、元のビルドファイルに書かれているように扱われるので、理解するのは容易です。 しかし、インポートするファイルから相対パスで参照しているファイルやリソースを参照することができなくなります。 この理由により、Antは、インポートされるファイルそれぞれについて、そのファイルのあるパスをプロパティに追加します。 このパスを使えば、インポートされるファイルはリソースの相対パスを参照することができるようになっています。

So if I import for example a docsbuild.xml file named builddocs, I can get its path as ant.file.builddocs, similarly to the ant.file property of the main buildfile.
Note that "builddocs" is not the filename, but the name attribute present in the imported project tag.

元ビルドファイルにおけるant.fileプロパティと同様に、 たとえば builddocsという名前がつけられた、docsbuild.xml ファイルをインポートする場合、 ant.file.builddocsというプロパティで、そのファイルのパスを取得できます。
なお、"builddocs"というのはファイル名ではなく、 インポートするファイルの<project>code>タグのname属性に書かれた値です。

Important: We have not finalized how relative file references will be resolved in deep/complex build hierarchies -such as what happens when an imported file imports another file. Use absolute references for enhanced build file stability, especially in the imported files.

重要: インポートされるファイルがさらに別のファイルをインポートしているときのように、 複雑で深いビルド階層に対しては、まだ、完全に相対パスを解決するように実装しきれていません。 現在のところは、安定した動作を得るため、インポートされるファイル内で絶対パスで参照するようにしてください。

Parameters

パラメータ

Attribute Description Required
file
The file to import.
Yes
optional
if true, do not issue stop the build if the file does not exist, default is false.
No
属性 説明 必須
file インポートしたいファイル名。 Yes
optional 既定値はfalseです。trueを指定すると、ファイルが存在しない場合でもビルドを停止しません。 No

Examples

  <import file="../common-targets.xml" />

Imports targets from the common-targets.xml file that is in a parent directory.

親ディレクトリにある common-targets.xml に書かれたターゲットをインポートします。

  <import file="${deploy-platform}.xml" />

Imports the project defined by the property deploy-platform

deploy-platform プロパティで定義されたプロジェクトをインポートします。


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