Ant のタスクの概要

Ant で利用できるタスクは数多くあるので、 個々のタスクに何が出来るのかを全て知ることは難しいかもしれません。 次の表には、個々のタスクの短い説明と、完全なドキュメントへのリンクがあります。

アーカイブタスク
検査/カバレージのタスク
コンパイルタスク
配備タスク
ドキュメントタスク
EJBタスク
実行タスク
ファイルタスク
Java2 拡張機能タスク
ロギングタスク
メールタスク
様々なタスク
.NETタスク
前処理タスク
プロパティータスク
リモートタスク
SCMタスク
テスト用タスク
Visual Age for Javaタスク

アーカイブタスク [最初に戻る]
タスク名 説明
BUnzip2

gzip または bzip2 で圧縮されたファイルを解凍します。

BZip2

gzip または bzip2 アルゴリズムを用いてファイルを圧縮します。 このタスクでは依存関係チェックを行いませんので、 出力ファイルは常に生成されます。

Cab

マイクロソフト CAB アーカイブファイルを生成します。 これは、 JarZipタスクと同じように実行されます。 このタスクは、 実行パスにある外部のcabarcツール(Microsoft提供) を用いて Windows 上で動作します。

Ear

Jarタスクの拡張で、 Enterprise Application archive を作るためのファイルを特別に扱います。

GUnzip

gzipファイルを解凍します。

GZip

ファイルの集合を gzip で圧縮します。

Jar

ファイルの集合を jar で圧縮します。

Jlink

非推奨 代りに JarZipタスクの zipfileset zipgroupfileset 属性を使ってください。

Manifest

マニフェストファイルを生成します。

Rpm

Linux 用インストールファイルを生成するための rpm実行ファイルを起動します。 このタスクは現在 Linux や、他の RPM をサポートする Unix プラットフォームでのみ動作します。

SignJar

javasign コマンドラインツールを用いて jar や zip ファイルに署名します。

Tar

tarアーカイブを作成します。

Unjar

jar ファイルを解凍します。

Untar

tar ファイルを解凍します。

Unwar

warファイルを解凍します。

Unzip

zipファイルを解凍します。

War

Jarタスクの拡張で、 Web Application Archive の WEB-INF/libWEB-INF/classesWEB-INFディレクトリに入れるファイルを特別に扱います。

Zip

zipファイルを作成します。

検査/カバレージのタスク [最初に戻る]
タスク名 説明
JDepend

jdependパーザーを起動します。 このパーザーは " Java ソースファイルディレクトリを全検索し、 個々の Java パッケージのために設計品質メトリックスを生成します。

JProbe このタスクは JProbe スイートの ツールを実行します。このタスクは JProbe Suite Server Side 3.0 を用いて実装されました。
MMetrics Metamata Metrics/WebGain Quality Analyzer ソースコードアナライザ を用いて Java ソースコードの相関を計算し、結果を XML ファイルに出力します。
Maudit Metamata Metrics/WebGain Quality Analyzerソースコードアナライザを用いて Java のソースコードとバイトコードファイルの静的解析を実行します。

コンパイルタスク [最初に戻る]
タスク名 説明
Depend ソースと比較して、どのクラスファイルが古いか判断し、 古いクラスに依存する他のクラスも含めたクラスファイルを削除し、 削除したクラスを強制的に再コンパイルされるようにします。 典型的には、Javac タスクと組み合わせて使われます。
Javac 実行中の(Antの)VM 内で、指定されたソースファイルをコンパイルします。 fork 属性が指定された場合は、別の VM 内で実行されます。
JspC JSP コンパイラを実行します。 JSP ページの初回の起動を速くしたり、 JDKがフルインストールされてなくてもサーバーに配備したり、 単に配備せずにページの文法チェックを行うために、 JSP ページをプリコンパイルします。 生成された java ソースをコンパイルするのに、 Javac タスクが使えます。 (WebLogic JSP のコンパイルには、 Wljspcタスクを参照してください)
NetRexxC

実行中の(Antの)VM上で、 NetRexx ソースツリーをコンパイルします。

Rmic

指定されたファイル(複数)に対し rmic コンパイラを実行します。

Wljspc

WebLogic の JSP コンパイラweblogic.jspcを用いて、 JSP ページをコンパイルします。 (WebLogic でない JSP のコンパイルについては、 JspCタスクをご覧下さい)。

配備タスク [最初に戻る]
タスク名 説明
ServerDeploy

ベンダー依存の J2EE サーバーの"hot"配備ツールを実行するためのタスクです。

ドキュメントタスク [最初に戻る]
タスク名 説明
Javadoc/Javadoc2

javadoc ツールを用いてソースコードのドキュメントを作成します。 javadoc2 タスクは非推奨のタスクです。代わりに javadoc を使ってください。

Stylebook

Apache Stylebook documentation generator を実行します。 このツールのコマンドライン版と異なり、 stylebook を実行するには、3つ全ての引数が必要になります。

EJB タスク [最初に戻る]
タスク名 説明
EJB Tasks

(EJB タスクについて記述されているドキュメントをご覧ください。)

実行タスク [最初に戻る]

タスク名 説明
Ant

与えられたビルドファイルに対し Ant を実行します。 オプションとしてプロパティ(新しい値も可)を渡せます。 このタスクはサブプロジェクトをビルドするのに使うことができます。

AntCall

同じビルドファイル中で別のターゲットを実行します。 オプションとしてプロパティ(新しい値も可)を渡せます。

Apply/ExecOn

システムコマンドを実行します。 os属性が指定された場合、 指定されたオペレーティングシステムの一つの上で Ant が実行されているときのみ、 そのコマンドが実行されます。

Dependset

このタスクはソースファイルの集合と ターゲットファイルの集合を比較します。 ソースファイルの一部が、ターゲットファイルのものより新しい場合、 全てのターゲットファイルを削除します。

Exec

システムコマンドを実行します。 os属性が指定された場合、 指定されたオペレーティングシステムの一つの上で Ant が実行されているときのみ、 そのコマンドが実行されます。

Java

実行中の(Antの)VM 内で、Java クラスを実行します。 fork 属性が指定された場合は、別の VM 内で実行されます。

Parallel

別の Ant タスクを入れることができるコンテナタスクです。 <parallel>タグ中で指定された ネストされた個々のタスクは、個別のスレッドで実行されます。

Sequential

別の Ant タスクを入れることができるコンテナタスクです。 ネストされたタスクは単純に順序通り実行されます。 代表的な使い方は、 <parallel>タグ中の一部のタスクの実行を 順序通りに行う事をサポートです。

Sleep

指定された時間だけ実行を一時停止します。 ビルドや配備プロセスにおいて、タスク間に間隔が必要な場合に便利です。

Subant

全てのサブビルドファイルの指定したターゲットを呼び出します。 これは antタスクの拡張で、プロジェクトの一括実行に使われます。

Waitfor

指定された条件の集合が true になるまで、ブロックを実行します。 このタスクは、 Parallelタスクを プロセスの集合と同期させるのに使われるよう意図されています。

ファイルタスク [最初に戻る]
タスク名 説明
Attrib

一つのファイルや指定したディレクトリ内の全てのファイルの パーミッションや属性を変更します。 現在、Windows環境でのみ効果があります。

Checksum

一つのファイルや、ファイルの集合に対しチェックサムを生成します。 このタスクはチェックサムの検証を実行するのにも使われます。

Chgrp

一つのファイルや指定したディレクトリ内のすべてのファイルの グループオーナーを変更します。 現在これは、Unix環境でのみ効果があります。

Chmod

一つのファイルや、指定されたディレクトリ内の全てのファイルのパーミッションを変更します。 現在は、Unix 上でのみ効果があります。 パーミッションの指定方法はchmodコマンドの引数のような UNIX 形式です。

Chown

一つのファイルや、指定したディレクトリ内のすべてのファイルの オーナーを変更します。 現在、これはUnix環境でのみ効果があります。

Concat

複数のファイルを連結して、 単一のファイルや Ant のログシステムに出力します。

Copy

一つのファイルやファイルセットを新しいファイルや、ディレクトリにコピーします。

Copydir

非推奨。 代わりに Copyタスクを使ってください

Copyfile

非推奨。 代わりに Copyタスクを使ってください

Delete

一つのファイルや、指定されたディレクトリ内のすべてのファイルとサブディレクトリを削除したり、 一つ以上のファイルセットで 指定されたファイルの集合を削除します。

Deltree

非推奨。 代わりに Deleteタスクを使ってください

Filter

プロジェクトにトークンフィルターを設定したり、 指定されたファイルより複数のトークンフィルターを読み込み、 これらをフィルターとして設定したりします。 トークンフィルターは、 ファイルのコピー操作を行う全てのタスクで使われます。

FixCRLF

タブ、キャリッジリターン、改行、EOF 文字を追加、削除して 一つのファイルを更新します。

Get

URLよりファイルを取得します。

Mkdir

一つのディレクトリを生成します。 必要であれば、存在しない親ディレクトリも生成されます。

Move

一つのファイルを、新しいファイルやディレクトリに移動したり、 ファイル(複数)の集合(複数)を新しいディレクトリに移動します。

Patch

オリジナルファイルに対し、"diff" ファイルを適用します。

Rename

非推奨。 代わりに moveタスクを使ってください

RenameExtensions

非推奨。代わりに、 Moveタスクを glob mapperとともに使ってください。

Replace

replace は、選択されたファイルの 指定した文字列を別の文字列で置き換えるための ディレクトリベースのタスクです。

ReplaceRegExp

選択されたファイル、あるいは、ファイル集合中の、 与えられた正規表現にマッチするものを代入パターンで置き換える、 ディレクトリベースのタスクです。

Sync

2つのディレクトリツリーを同期化します。

Tempfile

一時ファイル用の名前を生成し、 指定されたプロパティにその名称を設定します。

Touch

ファイルの更新日時を変更します。 同じ時刻でファイルを生成することもできます。

Java2 拡張機能タスク [最初に戻る]
タスク名 説明
Jarlib-available

FileSetやExtensionSetに、拡張機能が存在するかチェックします。 存在した場合、指定したプロパティーがセットされます。

Jarlib-display

指定した jar ファイルに含まれる "Optional Package" と "Package Specification" の情報を表示します。

Jarlib-manifest

マニフェスト中の全ての依存関係を宣言するマニフェストを生成するタスクです。 依存関係は、指定されたパスから探され、 jarのマニフェスト内の拡張機能/"Optional Package"仕様が検索されます。 [コメント:分かるような分からないような]

Jarlib-resolve

拡張機能を満たすように jar の配置を試み、 jar の位置を指定されたプロパティに設定します。

ロギングタスク [最初に戻る]
タスク名 説明
Record

ビルドプロセスのイベントの出力をファイルへログ記録するリスナーを実行します。 同時に複数のrecorderが存在できます。 それぞれのrecorderは一つのファイルに関連づけられます。

メールタスク [最初に戻る]
タスク名 説明
Mail

SMTP メールを送信するタスク

MimeMail

非推奨 代わりにMailタスクを使ってください。

様々なタスク [最初に戻る]
タスク名 説明
Defaultexcludes

ビルドファイル内の、デフォルト除外パターンのリストを更新します。

Echo

テキストをSystem.outかファイルにエコーします。

Fail

BuildException例外をスローして現在のビルドを強制終了します。 オプションとして、追加情報を表示します。

GenKey

キーストアに暗号鍵を生成します。

Input

ビルドプロセス内でユーザー対話処理を可能にします。 メッセージを表示し、コンソールからの入力行を読み込みます。

Script

Apache BSFでサポートされるプログラミング言語の スクリプトを実行します。

Sound

ビルドが失敗したか成功したかにより、 ビルドの終わりにサウンドファイルを再生します。

Splash

スプラッシュウィンドウを表示します。

Sql

一連の SQL 文を JDBC を通じてデータベースに対し実行します。 SQL 文はsrc属性を用いてテキストファイルから読み込んだり、 SQL タグに囲まれた部分から読み込むことができます。

Taskdef

プロジェクトに新しいタスク定義を追加します 新しいタスクは、プロジェクト内で利用することができます。

TStamp

実行中のプロジェクト内で DSTAMPTSTAMPおよび TODAYプロパティを設定します。 現在の日時に基づきます。

Typedef

プロジェクトに新しいデータ型の定義を追加します。 新しいデータ型は、プロジェクト内で利用することができます。

XmlValidate

XML ファイルが有効であるか(あるいは単に整形式であるか)チェックします。 このタスクは、Ant でデフォルトで使われている XML パーサーを使いますが、 必要であれば SAX1/2 パーサーを指定することもできます。

.NET タスク [最初に戻る]
タスク名 説明
.NET タスク

(.NETタスクに記述されているドキュメントをご覧ください)

前処理タスク [最初に戻る]
タスク名 説明
ANTLR

文法ファイルに対し、 ANTLR Translator generator を実行します。

AntStructure

Ant がその時点でわかっている全てのタスクの情報を含む Ant ビルドファイルの DTD を生成します。

IContract

iContract DBC プリプロセッサを使った Java クラスツール。 このタスクは iControl用の プロパティファイルを生成します。 iControlはGUIで、アサーションの ON/OFF が可能です。

Import

他のビルドファイルをオーバーライドします。 自分のターゲットで上書きすることができます。

JavaCC

文法ファイルに対し、 JavaCCコンパイラ-コンパイラを実行します。

Javah

JavaクラスからJNIヘッダを生成します。

JJDoc

JavaCCコンパイラ-コンパイラ用の JJDoc ドキュメントジェネレータを実行します。 JJDocはJavaCCパーサー仕様に従い、BNF文法の文書を作成します。 コマンドラインオプションで決められている、3つの操作が可能です。 このタスクは、作成したBNF文法ドキュメントより文書ファイルが新しければ、 JJDocを実行するだけです。

JJTree

JavaCC コンパイラ-コンパイラ用の JJTree プリプロセッサを実行します。 生成するJavaCCソースの様々な場所に、パースツリーのビルドアクションを挿入します。 JJTreeの出力は、JavaCCを通してパーサーを作成するのに使われます。 このタスクは、 生成された JavaCC ファイルより文法ファイルが新しい場合のみ、 JJTree を実行します。

Macrodef

他のタスクの上に組み立てるマクロとして新たなタスクを定義します。

MParse

一つの文法ファイルに対し、 Metamata MParseコンパイラ-コンパイラを実行します。

Native2Ascii

ネイティブエンコーディングからUnicodeエスケープしたASCIIに、 ファイルを変換します。 一般的な用途は、 OSネイティブエンコーディングのままのソースファイルを、 コンパイル前に ASCII に変換することです。

Presetdef

既存のタスクを利用して新しいタスクを定義します。 属性や子要素はデフォルトの値になります。

Translate

特別なトークンで区切られたファイル中のキーを区別し、 それらを、リソースバンドルより読み込まれた値に置換します。

Xslt/Style

XSLT によりドキュメントの集合を処理します。

プロパティタスク [最初に戻る]
タスク名 説明
Available

指定したファイル、ディレクトリ、クラスパス中のクラス、 あるいはJVM のシステムリソースが存在するか、などの条件で 実行時にプロパティを設定します。

Basename

指定したパスの最後の要素をプロパティに設定します。

BuildNumber

ビルド番号をつけるに用いられるタスク。

Condition

指定された条件が真である場合、プロパティを設定します - このタスクは Availableおよび Uptodate を汎化したものです。

Dirname

プロパティに 指定したファイルに依存した値、最後のパス要素を含まない値(訳注:ディレクトリ名)をセットします。

Echoproperties

現在のプロパティを一覧します。

LoadFile

ファイルを読み込み、プロパティに設定します。

LoadProperties

ファイルの内容を Ant のプロパティとして読み込みます。 このタスクは、 ネストされた<filterchain> 要素をサポートしている点と、 target の外で指定できない点を除いて、 <property file="..."/> と等価です。

PathConvert

ネストしたpath、path参照、filelist参照やfileset参照を プラットホームで利用可能な形式に変換します。 指定したセパレータで分割された要素のリストや 指定したプロパティーに保存することができます。

Property

プロジェクト内で、 (名前と値で)プロパティを設定したり、 (ファイルやリソースから)複数のプロパティを設定します。

PropertyFile

プロパティファイルを生成あるいは変更します。 アプリケーションサーバやアプリケーション用の設定ファイルを 自動的に更新したい場合に便利です。 典型的な用途は、 自動的なビルド番号の生成する、 ビルドプロパティファイルを保存する、 日付の操作を行うなどです。

Uptodate

与えられたターゲットファイルがソースファイルの集合よりも 新しい場合にプロパティを設定します。

Whichresource

クラスやリソースを探します。

XmlProperty

プロパティの値を整形式の XML ファイルよりロードします

リモートタスク [最初に戻る]
タスク名 説明
FTP

基本的なFTPクライアントの実装で、 ファイルの送信、受信、リスト、削除やディレクトリ生成が可能です。

Rexec

rexec セッションを自動化するためのタスクです。

Scp

SSHを使って、リモートのサーバから/へファイルのコピーを行います。

setproxy

Javaのwebプロキシプロパティーをセットし、 同じJVM 内で実行されているタスクやコードが、 ファイヤーウォールを通してリモートのウェブサイトへアクセスできるようにします。

Sshexec

SSHを使って、リモートサーバ上でコマンドを実行します。

Telnet

リモートのtelnetセッションを自動化するタスク。 このタスクは、 受信待ちの文字列や送信するテキストを指定するために、 ネストした <read> および <write> タグを用います。

SCMタスク [最初に戻る]
タスク名 説明
Cvs

CVS リポジトリより取り出したパッケージやモジュールを扱います。

CvsChangeLog

CVS リポジトリに記録された変更履歴のXMLレポートを生成します。

CVSPass

.cvspass ファイルにエントリーを追加します。 このファイルにエントリーを追加することは、 cvs login コマンドと同じ効果があります。

CvsTagDiff

CVSリポジトリ に記録された 2つのタグや日付の間の変更を XML形式のレポートファイルに生成します。

ClearCase

ClearCase の cleartool コマンドである checkincheckoutuncheckoutupdatelockunlockmklbtypermtypemklabelmkattrmkdirmkelemmkbl を実行するタスク

Continuus/Synergy

Continuus の ccmcheckinccmcheckoutccmcheckintaskccmreconfigureおよび ccmcreateTaskを実行するタスク

Microsoft Visual SourceSafe

Visual SourceSafe の vssget, vsslabelvsshistoryvsscheckinvsscheckoutvssaddvsscpおよびvsscreate コマンドを実行するタスク

Perforce

Perforce の p4syncp4changep4editp4submitp4havep4labelp4counterp4reopenp4revertおよびp4add コマンドを実行するタスク。

Pvcs

PVCS リポジトリからソースコードの最新版を取り出すことを可能にします。

SourceOffSite

SourceOffSiteの sosgetsoslabelsoscheckinおよびsoscheckout コマンドを実行するタスク

StarTeam

StarTeam の stcheckoutstcheckinstlabelおよびstlistコマンドを実行するタスク。 Starteam タスクは非推奨のタスクです。 代わりに STCheckout を使ってください。

テスト用タスク [最初に戻る]
タスク名 説明
Junit

Junitテストフレームワークより テストを実行します。 このタスクは JUnit 3.0 以上 3.7 までで動作確認されています。 JUnit 3.0 より前のバージョンでは動作しないでしょう。

JunitReport

Junitタスクにより生成された個々の XML ファイルをマージし、 マージした結果のドキュメントにスタイルシートを適用します。 テストケースの結果を閲覧可能なレポートとして出力します。

Test

org.apache.testlet フレームワークの単体テストを実行します。

Visual Age for Java タスク [最初に戻る]
タスク名 説明
Visual Age for Java Tasks

(Visual Age for Java タスクについて記述されているドキュメントをご覧ください。)


Copyright © 2001-2004 The Apache Software Foundation. All rights Reserved.

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