コピー

説明

ファイルまたはリソースコレクションを新しいファイルまたはディレクトリにコピーします。デフォルトでは、ソースファイルが宛先ファイルより新しい場合、または宛先ファイルが存在しない場合にのみファイルがコピーされます。Antにおける「新しい」の意味については、granularity属性を参照してください。ただし、overwrite属性を使用して、ファイルを明示的に上書きすることができます。

リソースコレクションは、コピーするファイルのグループを選択するために使用されます。リソースコレクションを使用するには、todir属性を設定する必要があります。注意 一部のリソース（例えばfileリソース）は絶対パスを名前として返し、ネストされたマッパー（またはflatten属性）を使用せずにそれらを使用すると、予期しない結果になる場合があります。

注意：コピー操作でフィルターを使用する場合は、テキストファイルへのコピーに制限する必要があります。バイナリファイルは、コピー操作によって破損します。これは、フィルターがfilterタスクによって暗黙的に定義されている場合でも、filtersetsとしてコピー操作に明示的に提供されている場合でも適用されます。エンコーディングに関する注意を参照してください。

パラメータ

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

任意のファイルシステムベースのリソースコレクション

リソースコレクションは、コピーするファイルのグループを選択するために使用されます。リソースコレクションを使用するには、todir属性を設定する必要があります。

Ant 1.7より前は、ネストされた要素として<fileset>のみがサポートされていました。

mapper

ネストされたmapper要素を使用して、ファイル名の変換を定義できます。<copy>で使用されるデフォルトのマッパーはidentityマッパーです。

Ant 1.6.3以降、mapper要素の代わりにfilenamemapperタイプを使用できます。

マッパーに渡されるソース名は、使用するリソースコレクションによって異なります。<fileset>または基本ディレクトリを提供する他のコレクションを使用する場合、マッパーに渡される名前は、基本ディレクトリを基準とした相対ファイル名になります。それ以外の場合は、ソースの絶対ファイル名を使用します。

filterset

FilterSetは、コピーされるファイル内のトークンを置換するために使用されます。FilterSetを使用するには、ネストされた<filterset>要素を使用します。

複数のfiltersetを使用できます。

filterchain

コピータスクは、ネストされたFilterChainをサポートします。

同じ<copy>タスク内に<filterset>要素と<filterchain>要素が使用されている場合、すべての<filterchain>要素が最初に処理され、次に<filterset>要素が処理されます。

例

単一ファイルをコピーする

<copy file="myfile.txt" tofile="mycopy.txt"/>

単一ファイルをディレクトリにコピーする

<copy file="myfile.txt" todir="../some/other/dir"/>

ディレクトリを別のディレクトリにコピーする

<copy todir="../new/dir">
  <fileset dir="src_dir"/>
</copy>

一連のファイルをディレクトリにコピーする

<copy todir="../dest/dir">
  <fileset dir="src_dir">
    <exclude name="**/*.java"/>
  </fileset>
</copy>

<copy todir="../dest/dir">
  <fileset dir="src_dir" excludes="**/*.java"/>
</copy>

一連のファイルをディレクトリにコピーし、ファイル名に.bakを動的に追加する

<copy todir="../backup/dir">
  <fileset dir="src_dir"/>
  <globmapper from="*" to="*.bak"/>
</copy>

一連のファイルをディレクトリにコピーし、すべてのファイル内の@TITLE@をFoo Barに置き換える。

<copy todir="../backup/dir">
  <fileset dir="src_dir"/>
  <filterset>
    <filter token="TITLE" value="Foo Bar"/>
  </filterset>
</copy>

現在のCLASSPATH設定からすべてのアイテムを宛先ディレクトリに収集し、ディレクトリ構造をフラット化する。

<copy todir="dest" flatten="true">
  <path>
    <pathelement path="${java.class.path}"/>
  </path>
</copy>

いくつかのリソースを指定されたディレクトリにコピーします。

<copy todir="dest" flatten="true">
  <resources>
    <file file="src_dir/file1.txt"/>
    <url url="https://ant.dokyumento.jp/index.html"/>
  </resources>
</copy>

上記の例でflatten属性を使用しなかった場合、<file>リソースは完全パスをソース名とターゲット名として返し、まったくコピーされません。一般的に、絶対パスを名前として使用するリソースと共に明示的なマッパーを使用することをお勧めします。

最新の2つのリソースを宛先ディレクトリにコピーします。

<copy todir="dest" flatten="true">
  <first count="2">
    <sort>
      <date xmlns="antlib:org.apache.tools.ant.types.resources.comparators"/>
      <resources>
        <file file="src_dir/file1.txt"/>
        <file file="src_dir/file2.txt"/>
        <file file="src_dir/file3.txt"/>
        <url url="https://ant.dokyumento.jp/index.html"/>
      </resources>
    </sort>
  </first>
</copy>

前の例に続く段落はこの例にも適用されます。

Unixに関する注意：ファイルをコピーするときはファイルのアクセス許可は保持されません。代わりにデフォルトのUMASKアクセス許可になります。これは、現在のJavaランタイムでファイルのアクセス許可を問い合わせたり設定したりする手段がないことが原因です。アクセス許可を保持するコピー機能が必要な場合は、代わりに<exec executable="cp" ... >を使用してください。

Windowsに関する注意：既に存在するファイルにファイルをコピーする場合でも、大文字と小文字が異なる場合、コピーされたファイルは元のファイルの大文字と小文字が反映されます。回避策としては、コピーする前に宛先ディレクトリにあるファイルを削除します。

エンコーディングに関する重要な注意：フィルター処理されたバイナリファイルが破損する理由は、フィルター処理にReaderクラスを使用してファイルを読み込むことが含まれるためです。これには、ファイルのエンコーディング方法を指定するエンコーディングがあります。エンコーディングにはUTF-8、UTF-16、Cp1252、ISO-8859-1、US-ASCIIなど、多くの種類があります。Windowsのデフォルト文字エンコーディングはCp1252、Unixでは通常UTF-8です。これら2つのエンコーディングには、不正なバイトシーケンスがあります（UTF-8の方がCp1252より多い）。

Readerクラスがこれらの不正なシーケンスをどのように処理するかは、文字デコーダの実装によって異なります。現在のSun Javaの実装では、これらを有効な文字にマップします。以前のSun Java（1.3以前）では、MalformedInputExceptionをスローしていました。IBM Java 1.4もこの例外をスローします。文字のマッピングによって破損が発生します。

デフォルトが通常UTF-8であるUnixでは、これは大きな問題です。ISO-8859-1からの非US-ASCII文字（例えば、デンマーク語のœ文字）を含むファイルを作成して編集するのは簡単です。Antで（フィルター処理して）コピーすると、文字が疑問符などに変換されます。

Antができることはあまりありません。どのファイルがバイナリファイルかを判断することはできません（韓国語のUTF-8バージョンには、上位ビットが設定されているバイトがたくさんあります）。現在のSun Javaの実装では、不正な文字シーケンスについて通知されません。

US-ASCIIのみを含むフィルター処理を行うための1つの方法は、ISO-8859-1エンコーディングを使用することです。これは不正な文字シーケンスを含まないようであり、下位7ビットはUS-ASCIIです。別の方法は、LANG環境変数をus.utf8のようなものからusに変更することです。