リソース

ファイルのようなエンティティは、リソースという概念に抽象化できます。リソースの実装は、ファイルのような属性へのアクセスを提供するだけでなく、可能な限り、基になるエンティティからのコンテンツの読み取りや、エンティティへのコンテンツの書き込みの手段を提供する必要があります。リソースの概念は Apache Ant 1.5.2 で導入されましたが、リソースを明示的に使用できるのはAnt 1.7 以降です。

組み込みリソース型

• resource — 基本リソース。
• bzip2resource — BZip2 圧縮リソース。
• file — ファイル。
• gzipresource — GZip 圧縮リソース。
• javaresource — Java クラスローダー経由でロード可能なリソース。
• javaconstant — Java クラスローダー経由でロード可能なクラス内の定数。
• propertyresource — Ant プロパティ。
• string — テキスト文字列。
• tarentry — tar ファイル内のエントリ。
• url — URL。
• xzresource — XZ 圧縮リソース。
• zipentry — zip ファイル内のエントリ。

resource

基本リソース。他のリソース型はこの基本型から派生します。そのため、そのすべての属性が利用可能ですが、ほとんどの場合、無関係な属性は無視されます。この実装とすべてのリソース実装は、単一要素のリソースコレクションとしても使用できます。

file

ローカルファイルシステムの規則を介してアクセス可能なファイルを表します。

javaresource

Java クラスローダー経由でロード可能なリソースを表します。

クラスパスは、ネストされたクラスパス要素としても指定できます。ここで、<classpath> はパスのような構造です。

javaconstant

Java 定数の値をロードします。javaresourceの特殊なものとして、そのすべての属性とネストされた要素がサポートされています。定数は public static として指定する必要があります。そうしないとロードできません。

例

これにより、org.acme.Main クラスの定数 VERSION の値が version プロパティにロードされます。そのクラスを見つけるためのクラスパスは、ネストされた classpath 要素を介して提供されます。

<loadresource property="version">
  <javaconstant name="org.acme.Main.VERSION">
    <classpath>
      <pathelement location="${acme.lib.dir}"/>
    </classpath>
  </javaconstant>
</loadresource>

その定数（build.xml）の内容で新しいファイル c:/temp/org.apache.tools.ant.Main.DEFAULT_BUILD_FILENAME を作成します。

<copy todir="c:/temp">
  <javaconstant name="org.apache.tools.ant.Main.DEFAULT_BUILD_FILENAME"/>
</copy>

zipentry

ZIP アーカイブ内のエントリを表します。アーカイブは、archive 属性またはネストされた単一要素のリソースコレクションを使用して指定できます。zipentry は、ネストされた要素としてファイルシステムリソースのみをサポートします。

tarentry

TAR アーカイブ内のエントリを表します。アーカイブは、archive 属性またはネストされた単一要素のリソースコレクションを使用して指定できます。

gzipresource

これはスタンドアロンのリソースではなく、リソースの内容をその場で圧縮する別のリソースのラッパーです。単一要素のリソースコレクションをネストされた要素として指定する必要があります。

bzip2resource

これはスタンドアロンのリソースではなく、リソースの内容をその場で圧縮する別のリソースのラッパーです。単一要素のリソースコレクションをネストされた要素として指定する必要があります。

xzresource

これはスタンドアロンのリソースではなく、リソースの内容をその場で圧縮する別のリソースのラッパーです。単一要素のリソースコレクションをネストされた要素として指定する必要があります。

XZ 圧縮のサポートは、Apache Ant 1.10.1 以降で追加され、Ant ディストリビューションに含まれていない外部ライブラリに依存します。詳細については、ライブラリの依存関係を参照してください。

url

URL を表します。

string

Java 文字列を表します。書き込むことはできますが、一度しか書き込めません。その後、再度書き込むとエラーになります。

リソースはネストされたテキストもサポートしており、value 属性が設定されていない場合にのみ指定できます。

<string>
    self.log("Ant version =${ant.version}");
</string>

propertyresource

Ant プロパティを表します。

リソースコレクション

リソースコレクションは、多数のリソースをグループ化するエンティティの抽象化です。Ant の「レガシー」データ型のいくつかは、リソースコレクションとして動作するように変更されました。

• fileset、dirset、multirootfileset、filelist、およびpath（および派生型）は、file リソースを公開します。
• tarfileset は、構成に応じて、file リソースまたはtarentry リソースを公開できます。
• zipfileset は、構成に応じて、file リソースまたはzipentry リソースを公開できます。
• propertyset は、property リソースを公開します。

不思議なことに、一部のタスクは、リソースコレクションとして正当に動作することさえあります。

• concat は連結されたリソースを公開し、たとえば、フィルタリングを Ant のリソース関連機能に追加します。

追加の組み込みリソースコレクション

• resources — ジェネリックリソースコレクション
• files — fileset に似たファイルのコレクション
• restrict — 指定された基準を満たすリソースのみを含むようにリソースコレクションを制限します。
• sort — ソートされたリソースコレクション
• first — ネストされたコレクションからの最初の n 個のリソース
• last — ネストされたコレクションからの最後の n 個のリソース
• allbutfirst — ネストされたコレクションからの最初の n 個のリソースを除くすべて
• allbutlast — ネストされたコレクションからの最後の n 個のリソースを除くすべて
• tokens — ネストされたコレクションから収集された文字列トークン
• union — ネストされたリソースコレクションのセット和
• intersect — ネストされたリソースコレクションのセット積
• difference — ネストされたリソースコレクションのセット差
• mappedresources — mapper を使用してネストされたリソースの名前をマップする汎用リソースコレクションラッパー。
• archives — さまざまなリソースコレクションをラップし、ネストされたリソースを ZIP または TAR アーカイブとして扱い、それらがその場で抽出されます。
• resourcelist — 名前が別のリソースから読み取られたリソースのコレクション。

resources

参照で使用するように設計された、汎用リソースコレクション。たとえば、サードパーティの Ant タスクが不明なタイプのリソースコレクションを生成した場合でも、<resources> コレクションを介してアクセスできます。このコレクションタイプの 2 番目の用途は、他のリソースコレクションのコンテナーとして、ネストされたコレクションの順序と重複するリソースを保持することです（union と比較してください）。

files

ファイルのグループ。これらのファイルは、多数のPatternSet から取得した絶対パターンによって一致します。これらは、ネストされた <patternset> 要素として指定できます。さらに、<files> は暗黙的な PatternSet を保持し、PatternSet のネストされた <include>、<includesfile>、<exclude>、および <excludesfile> 要素と、PatternSet の属性を直接サポートします。

ファイルセレクターは、ネストされた要素として使用できます。含めるには、すべてのセレクターでファイルを選択する必要があります。したがって、<files> は <and> ファイルセレクターコンテナーと同等です。

より簡単に言うと、このタイプは、ベースディレクトリのないfilesetと同等です。注意してください。ベースディレクトリがない場合、ファイルシステムスキャンは、包含および除外パターンのみに基づいています。ファイル名（または任意の）セレクターは、パターンベースの選択に基づいてファイルが含まれた後にのみ、スキャンプロセスに影響を与えることができます。

注意: カノニカルパスがそのパスと異なるすべてのファイル/ディレクトリは、シンボリックリンクと見なされます。Unixシステムでは、これは通常、ファイルが実際にシンボリックリンクであることを意味しますが、他のプラットフォームでは誤った結果につながる可能性があります。

restrict

リソースセレクターを使用して、ネストされたリソースコレクションを制限します。

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

単一のリソースコレクションが必要です。

ネストされたリソースセレクターは、論理ANDで結合され、含まれるリソースを「絞り込む」ために使用されます。これらはファイルセレクターを模倣していますが、当然ながらリソースを対象としています。いくつかの組み込みリソースセレクターは、内部antlib org.apache.tools.ant.types.resources.selectorsで利用可能です。

• name—名前でリソースを選択します。
• exists—存在するリソースを選択します。
• date—日付でリソースを選択します。
• type—型でリソースを選択します。
• size—サイズでリソースを選択します。
• instanceof—クラスまたはAntデータ型でリソースを選択します。
• and—ネストされたリソースセレクターをandします。
• or—ネストされたリソースセレクターをorします。
• not—ネストされたリソースセレクターをnotします。
• none—ネストされたリソースセレクターによって選択されていないリソースを選択します。
• majority—ネストされたリソースセレクターの過半数によって選択されたリソースを選択します。
• modified—内容が変更されたリソースを選択します。
• contains—特定のテキスト文字列を含むリソースを選択します。
• containsregexp—内容が特定の正規表現に一致するリソースを選択します。
• compare—他のリソースとの比較に基づいてリソースを選択します。
• readable—ファイル（リソースはファイルである必要があります）が読み取り可能である場合、ファイルを選択します。
• writable—ファイル（リソースはファイルである必要があります）が書き込み可能である場合、ファイルを選択します。

name

名前でリソースを選択します。

exists

存在するリソースを選択します。

date

日付でリソースを選択します。

type

型（ファイルまたはディレクトリ）でリソースを選択します。

size

サイズでリソースを選択します。

instanceof

型でリソースを選択します。

and

ネストされたすべてのリソースセレクターで選択されている場合、リソースを選択します。

or

少なくとも1つのネストされたリソースセレクターで選択されている場合、リソースを選択します。

not

許可されている単一のネストされたリソースセレクターの選択結果を否定します。

none

ネストされたリソースセレクターによって選択されていない場合、リソースを選択します。

majority

ネストされたリソースセレクターの過半数によって選択されている場合、リソースを選択します。

compare

ネストされたリソースコンパレーターを使用して、1つ以上の「制御」リソースとの比較に基づいてリソースを選択します。

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

比較を行う対象のリソースは、リソースコレクションを示すネストされた<control>要素を使用して指定する必要があります。

例

名前空間の設定を想定

rsel="antlib:org.apache.tools.ant.types.resources.selectors"
rcmp="antlib:org.apache.tools.ant.types.resources.comparators"

<restrict>
  <fileset dir="src" includes="a,b,c,d,e,f,g"/>
  <rsel:compare when="le" against="all">
    <control>
      <resource name="d"/>
    </control>
    <rcmp:name/>
  </rsel:compare>
</restrict>

ファイルa、b、c、およびdを選択します。

<project rsel="antlib:org.apache.tools.ant.types.resources.selectors">
    <macrodef name="copyFromPath">
        <attribute name="todir"/>
        <attribute name="refid"/>
        <element name="nested-resource-selectors" optional="yes" implicit="true"/>
        <sequential>
            <mkdir dir="@{todir}" taskname="copyFromPath"/>
            <copy todir="@{todir}" taskname="copyFromPath">
                <restrict>
                    <path refid="@{refid}"/>
                    <rsel:or>
                        <nested-resource-selectors/>
                    </rsel:or>
                </restrict>
                <flattenmapper/>
            </copy>
        </sequential>
    </macrodef>
    <copyFromPath refid="classpath" todir="todir">
        <rsel:name name="log4j.properties"/>
        <rsel:name name="default.properties"/>
    </copyFromPath>
</project>

todirディレクトリを作成し、クラスパス（コンパイル中にすでに使用されている）からファイルlog4j.propertiesとdefault.propertiesを（存在する場合は）コピーします。

<project>
    <filelist id="allfiles" dir="${ant.home}/bin" files="ant.cmd,foo.txt,ant.bat,bar.txt,ant"/>
    <restrict id="missingfiles">
        <filelist refid="allfiles"/>
        <rsel:not xmlns:rsel="antlib:org.apache.tools.ant.types.resources.selectors">
            <rsel:exists/>
        </rsel:not>
    </restrict>
    <echo>These files are missed: ${toString:missingfiles}</echo>
</project>

リソースコレクションallfilesは、期待されるファイルのリストを定義します。制限missingfilesは、<not><exists>セレクターを使用して、存在しないすべてのファイルを取得します。最後に、読みやすい形式で取得するために、toString: pathshortcutを使用します：[echo] これらのファイルが見つかりません：....foo.txt;....bar.txt

sort

リソースの自然な順序に従って、または1つ以上のネストされたリソースコンパレーターによって、ネストされたリソースコレクションをソートします。

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

単一のリソースコレクションが必要です。

ソートは、1つ以上のリソースコンパレーターを指定することで制御およびカスタマイズできます。リソースは複数の基準に従ってソートできます。最初に指定したものが「最も外側」で、最後に指定したものが「最も内側」になります。いくつかの組み込みリソースコンパレーターは、内部antlib org.apache.tools.ant.types.resources.comparatorsで利用可能です。

リソースコンパレーター

• name—名前でリソースをソートします
• exists—存在によってリソースをソートします
• date—日付でリソースをソートします
• type—型でリソースをソートします
• size—サイズでリソースをソートします
• content—内容でリソースをソートします
• reverse—自然なソート順序、または単一のネストされたリソースコンパレーターのソート順序を反転します

name

名前でリソースをソートします。

exists

存在によってリソースをソートします。存在しないものは、存在するものよりも「小さい」と見なされます。

date

日付でリソースをソートします。

type

型（ファイルまたはディレクトリ）でリソースをソートします。ディレクトリにはファイルが含まれているため、「大きい」と見なされます。

size

サイズでリソースをソートします。

content

内容でリソースをソートします。

reverse

自然なソート順序、または単一のネストされたコンパレーターのソート順序を反転します。

例

<property name="eol" value="${line.separator}"/>
<pathconvert property="sorted" pathsep="${eol}">
  <sort>
    <tokens>
      <string value="foo bar etc baz"/>
      <stringtokenizer/>
    </tokens>
  </sort>
</pathconvert>

文字列型のfoo bar etc bazのリソースは、stringtokenizerによって4つのトークンに分割されます。これらのトークンはソートされ、sortedはbar baz etc fooの値を取得します。

<sort>
  <fileset dir="foo"/>
  <reverse xmlns="antlib:org.apache.tools.ant.types.resources.comparators">
    <date/>
  </reverse>
</sort>

これは、fooからすべてのファイルを取得し、変更日順に逆順でソートします。使用されるリソースコンパレーター（<reverse>と<date>）は内部antlibにあるため、名前空間を明示的に設定する必要があります。

first

ネストされたリソースコレクションから最初のcountリソースを含めます。これは、たとえば、より大きなコレクションから最初のいくつかの最も古い、最大のなどのリソースを選択するために、sortコレクションと組み合わせて使用​​できます。

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

単一のリソースコレクションが必要です。

last

Ant 1.7.1以降

ネストされたリソースコレクションから最後のcountリソースを含めます。これは、たとえば、より大きなコレクションから最後のいくつかの最も古い、最大のなどのリソースを選択するために、sortコレクションと組み合わせて使用​​できます。

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

単一のリソースコレクションが必要です。

allbutfirst

Ant 1.9.5以降

ネストされたリソースコレクションから最初のcountリソースを除くすべての要素を含めます。これは、たとえば、より大きなコレクションから最初のいくつかの最も古い、最大のなどのリソースを除くすべてを選択するために、sortコレクションと組み合わせて使用​​できます。

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

単一のリソースコレクションが必要です。

allbutlast

Ant 1.9.5以降

ネストされたリソースコレクションから最後のcountリソースを除くすべての要素を含めます。これは、たとえば、より大きなコレクションから最後のいくつかの最も古い、最大のなどのリソースを除くすべてを選択するために、sortコレクションと組み合わせて使用​​できます。

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

単一のリソースコレクションが必要です。

tokens

ネストされたリソースコレクションから収集されたstringトークンを含めます。TokenFilterでサポートされているのと同じトークナイザーを使用します。このリソースコレクションを創造的に使用することで、sort、grep -c、wc、wc -lなどのUnix関数の同等のものを実装できます。

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

• 単一のリソースコレクションが必要です。
• 1つのネストされたトークナイザーを指定できます。省略した場合、LineTokenizerが使用されます。

例

<concat>
  <union>
    <sort>
      <tokens>
        <resources refid="input"/>
        <linetokenizer includedelims="true"/>
      </tokens>
    </sort>
  </union>
</concat>

リソースコレクションinputに対してUnix sort -uを実装します。

集合演算

次のリソースコレクションは、集合演算を実装します

• union
• intersect
• difference

union

ネストされたリソースコレクションの和集合。

唯一サポートされている属性は refid であり、これによりこの union は、他の場所で定義された union への参照になります。指定された場合、他の属性やネストされた要素は許可されません。

intersect

ネストされたリソースコレクションの交差。

唯一サポートされている属性は refid であり、これによりこの intersect は、他の場所で定義された intersect への参照になります。指定された場合、他の属性やネストされた要素は許可されません。

difference

ネストされたリソースコレクションの差分。

以下の属性は、すべての集合演算リソースコレクションに適用されます。

例

<resources id="A">
    <string value="a"/>
    <string value="b"/>
</resources>
<resources id="B">
    <string value="b"/>
    <string value="c"/>
</resources>
<union id="union"><resources refid="A"/><resources refid="B"/></union>
<intersect id="intersect"><resources refid="A"/><resources refid="B"/></intersect>
<difference id="difference"><resources refid="A"/><resources refid="B"/></difference>
<echo>
  A: ${toString:A}                    = a;b
  B: ${toString:B}                    = b;c

  union     : ${toString:union}       = a;b;c
  intersect : ${toString:intersect}   = b
  difference: ${toString:difference}  = a;c
</echo>

mappedresources

Ant 1.8.0 以降

別のリソースコレクションをラップし、マッパーを使用してネストされたリソースの名前をマップします。

mappedresources がファイルシステムベースのリソースで構成されるリソースコレクションをラップしている場合でも、mappedresources はファイルシステムベースであるとは見なされません。つまり、ファイルシステムベースのリソースのみを許可するタスクで mappedresources を使用することはできません。

属性として指定されたパラメータ

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

単一のリソースコレクションが必要です。

単一のマッパーを使用して名前をマップできます。マッパーが指定されていない場合（正直なところ意味がありませんが）、アイデンティティマッパーが使用されます。

例

指定されたディレクトリからターゲットディレクトリにすべてのファイルをコピーし、拡張子として .bak を追加します。これは、copy に直接ネストされた mapper でも実行できることに注意してください。

<copy todir="${target}">
  <mappedresources>
    <fileset dir="${src}"/>
    <globmapper from="*" to="*.bak"/>
  </mappedresources>
</copy>

ファイルであるすべての CLASSPATH エントリを、ファイルシステム構造を保持せずに WEB-INF/lib ディレクトリに追加する WAR アーカイブを作成します。

<war destfile="${output}">
  <mappedresources>
    <restrict>
      <path path="${java.class.path}"/>
      <type type="file"/>
    </restrict>
    <chainedmapper>
      <flattenmapper/>
      <globmapper from="*" to="WEB-INF/lib/*"/>
    </chainedmapper>
  </mappedresources>
</war>

archives

Ant 1.8.0 以降

このリソースコレクションは、任意の数のネストされたリソースを受け入れ、それらのすべてのリソースが ZIP または TAR アーカイブであると想定します。<archives> によって返されるリソースは、ネストされたアーカイブの内容です。

このリソースコレクションは、zip ファミリーのタスクでのみサポートされている zipgroupfileset を一般化したものです。

唯一サポートされている属性は refid であり、これによりこの archives は、他の場所で定義された archives への参照になります。指定された場合、他の属性やネストされた要素は許可されません。

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

<archives> には、union 自体である <zips> および <tars> の2つのネストされた要素があります。つまり、ネストされた要素として任意の数のリソース（コレクション）を受け入れます。

<zips> のネストされたリソースは ZIP アーカイブとして扱われ、<tars> のネストされたリソースは TAR アーカイブとして扱われます。

例

クラスパスにあるすべての jar から ${target} にすべてのファイルをコピーします。

<copy todir="${target}">
  <archives>
    <zips>
      <restrict>
        <path path="${java.class.path}"/>
        <name name="*.jar"/>
      </restrict>
    </zips>
  </archives>
</copy>

resourcelist

Ant 1.8.0 以降

このリソースコレクションは、任意の数のネストされたリソースを受け入れ、それらのリソースを読み取り、読み取られた各行のリソースを返します。

行にコロンが含まれている場合、Ant はそれを URL として使用しようとし、失敗した場合（または行にコロンが含まれていない場合）、行の内容を名前とするファイルリソースを返します。

プロパティは各行で展開されます。プロパティの展開によって文字列ではなくリソースオブジェクト（カスタムプロパティヘルパーなどによる）が生成される場合、リソースは直接返されます。

<resourcelist> は、<filelist> を一般化したものです。

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

<resourcelist> は、ネストされた要素として任意の数のリソース（コレクション）を受け入れます。

さらに、<resourcelist> は、読み取られたリソースが展開される前にフィルタリング/変更するために使用できる、ネストされた <filterchain> 要素をサポートしています。このようなネストされた要素は、filterchain に対応します。

例

次の例では、実際に到達できるいくつかの代替URLの最初のURLからファイルをコピーします。ファイル mirrors.txt が次のようになっていると仮定します。

    mirrors.txt:
https://best.mirror.example.org/
http://second.best.mirror.example.org/mirror/of/best/
https://yet.another.mirror/
https://the.original.site/

<copy todir="${target}">
  <first>
    <restrict>
      <resourcelist>
        <file file="mirrors.txt"/>
      </resourcelist>
      <exists/>
    </restrict>
  </first>
</copy>