Copies a file or FileSet to a new file or directory. By default, files are only copied if the source file is newer than the destination file, or when the destination file does not exist. However, you can explicitly overwrite files with the overwrite attribute.

一つのファイルやファイルセットを新しいファイルやディレクトリにコピーします。 デフォルトでは、 ソースファイルがコピー先ファイルよりも新しいか、 コピー先ファイルが無い場合にのみ、 ファイルがコピーされます。 しかしながら、 overwrite属性により、 明示的にファイルを上書きすることもできます。

FileSets are used to select a set of files to copy. To use a <fileset>, the todir attribute must be set.

FileSetはコピーするファイルを選択するのに使われます。 <fileset>を使うには、 todir属性が設定されていなければなりません。



Attribute Description Required
file The file to copy. Yes, unless a nested <fileset> element is used.
preservelastmodified Give the copied files the same last modified time as the original source files. (Note: Ignored on Java 1.1) No; defaults to false.
tofile The file to copy to. With the file attribute, either tofile or todir can be used. With nested <fileset> elements, if the set of files is greater than 1, or if only the dir attribute is specified in the <fileset>, or if the file attribute is also specified, then only todir is allowed.
todir The directory to copy to.
overwrite Overwrite existing files even if the destination files are newer. No; defaults to false.
filtering Indicates whether token filtering using the global build-file filters should take place during the copy. Note: Nested <filterset> elements will always be used, even if this attribute is not specified, or its value is false (no, or off). No; defaults to false.
flatten Ignore the directory structure of the source files, and copy all files into the directory specified by the todir attribute. Note that you can achieve the same effect by using a flatten mapper. No; defaults to false.
includeEmptyDirs Copy any empty directories included in the FileSet(s). No; defaults to true.
failonerror Log a warning message, but do not stop the build, when the file to copy does not exist. Only meaningful when copying a single file. No; defaults to true.
verbose Log the files that are being copied. No; defaults to false.
属性 説明 必須
file コピーするファイル <fileset>要素がネストされていない限りはYes
preservelastmodified コピーされたファイルに、 オリジナルソースファイルと同じ最終更新時刻を設定します。 (注意: Java 1.1では無視) No; デフォルトはfalse.
tofile コピー先となるファイル file属性には、 tofiletodirのいずれかが使えます。 ネストする<fileset>要素には、 ファイルセットの数が1よりも大きいか、 dir属性のみしか <fileset>属性中で指定されていないか、 file属性も指定されている場合、 todirのみが指定可能です。
todir コピー先のディレクトリ
overwrite コピー先のファイルが新しくても既存のファイルを上書きします。 No; デフォルトはfalse
filtering コピーの際に、グローバルビルドファイルフィルタを用いた トークンフィルタを使うかどうか示します。 注意: この属性が指定されてなかったり、 この属性の値が false (noまたはoff) だったとしても、 ネストされた<filterset>要素が常に使われます。 No; デフォルトはfalse
flatten ソースディレクトリのディレクトリ構造を無視して、 全てのファイルを todir 属性で指定された一つのディレクトリにコピーします。 (デフォルトは "false") flatten mapper を使っても同じ効果が得られることに注意してください。 No; デフォルトはfalse
includeEmptyDirs ネストしたfilesetに入っている空のディレクトリをコピーするか。 No; デフォルトはtrue
failonerror コピーするファイルが存在しない場合、 警告メッセージをログ出力しますが、 ビルドを停止しません。 一つのファイルのコピーの時のみ意味があります。 No、デフォルトはtrue
verbose コピーされるファイルのログを取る No、デフォルトはfalse

Parameters specified as nested elements



FileSets are used to select sets of files to copy. To use a fileset, the todir attribute must be set.

filesetは、 コピーするファイルを選択するのに使われます。 fileset を使うには、 todir属性を設定しなければなりません。


You can define filename transformations by using a nested mapper element. The default mapper used by <copy> is the identity mapper.

mapper 要素をネストすることにより、 ファイル名の変換を定義できます。 <copy>で使われるデフォルトの mapper は identity mapperです。


FilterSets are used to replace tokens in files that are copied. To use a FilterSet, use the nested <filterset> element.

フィルターセットは、 コピーされるファイルにおいてトークンを置換するのに使われます。 フィルターセットを使うには、 <filterset> 要素をネストします。


The Copy task supports nested FilterChains.

copy タスクはネストされた FilterChainをサポートしています。


Copy a single file


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

Copy a single file to a directory


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

Copy a directory to another directory


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

Copy a set of files to a directory


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

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

Copy a set of files to a directory, appending .bak to the file name on the fly

ファイルの集合を、 ファイルコピー中にファイル名に.bakを追加しながら、 あるディレクトリにコピー。

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

Copy a set of files to a directory, replacing @TITLE@ with Foo Bar in all files.

全てのファイルにおいて、@TITLE@を Foo Bar に置換しながらファイルの集合をあるディレクトリにコピー

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

Unix Note: File permissions are not retained when files are copied; they end up with the default UMASK permissions instead. This is caused by the lack of any means to query or set file permissions in the current Java runtimes. If you need a permission-preserving copy function, use <exec executable="cp" ... > instead.

Unixでの注意: ファイルがコピーされる時ファイルパーミッションは保持されず、 代わりにデフォルトのUMASKパーミッションとなります。 これは、現在の Java ランタイムにおいて ファイルのパーミッションを取得し、設定する方法が無いことに起因しています。 パーミッションを保持するコピー機能が必要な場合には、 代わりに<exec executable="cp" ... > を使ってください。

Windows Note: If you copy a file to a directory where that file already exists, but with different casing, the copied file takes on the case of the original. The workaround is to delete the file in the destination directory before you copy it.

Windows での注意: あるファイルを、そのファイル名の、大文字小文字だけが違うファイルが既に存在するディレクトリにコピーする場合、 コピーされたファイルはオリジナルの大文字小文字を取ります。 ここで起こっているのは、 コピーする前に、出力先ディレクトリのファイルを 削除しているという事です。

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

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