Checksum

Description

説明

Generates checksum for files. This task can also be used to perform checksum verifications.

ファイルのチェックサムを生成します。 チェックサムの検証にも使うことができます。

Parameters

パラメータ

Attribute Description Required
file The file to generate checksum for. One of either file or at least one nested fileset element.
todir The root directory where checksums should be written. No. If not specified, checksum files will be written to the same directory as the files themselves. since Ant 1.6
algorithm Specifies the algorithm to be used to compute the checksum. Defaults to "MD5". Other popular algorithms like "SHA" may be used as well. No
provider Specifies the provider of the algorithm. No
fileext The generated checksum file's name will be the original filename with "." and fileext added to it. Defaults to the algorithm name being used. No
property This attribute can mean two different things, it depends on the presence of the verifyproperty attribute.
If you don't set the verifyproperty attribute, property specifies the name of the property to be set with the generated checksum value.
If you set the verifyproperty attribute, property specifies the checksum you expect to be generated (the checksum itself, not a name of a property containing the checksum).
This cannot be specified when fileext is being used or when the number of files for which checksums is to be generated is greater than 1.
No
totalproperty If specified, this attribute specifies the name of the property that will hold a checksum of all the checksums and file paths. The individual checksums and the relative paths to the files within the filesets they are defined in will be used to compute this checksum. (The file separators in the paths will be converted to '/' before computation to ensure platform portability). since Ant 1.6 No
forceoverwrite Overwrite existing files even if the destination files are newer. Defaults to "no". No
verifyproperty Specifies the name of the property to be set with "true" or "false" depending upon whether the generated checksum matches the existing checksum. When this is set, the generated checksum is not written to a file or property, but rather, the content of the file or property is used to check against the generated checksum. No
readbuffersize The size of the buffer (in bytes) to use when reading a file. Defaults to "8192" - you may get a better performance on big files if you increase this value. No
属性 説明 必須
file チェックサムを生成するファイル fileまたは fileset内部要素
todir チェックサムを書き出すルートとなるディレクトリ。 No. 指定しない場合、チェックサムはファイル自身と同じディレクトリに書かれる。 Ant 1.6 〜
algorithm チェックサムを計算するのに使用するアルゴリズム。 デフォルトは"MD5"。 "SHA"のような一般的なアルゴリズムも使用できる。 No
provider アルゴリズムのプロバイダ。 No
fileext 生成するチェックサムファイルのファイル名につける拡張子。 オリジナルのファイル名に、"." および fileext を加えた名前となる。 デフォルトは、アルゴリズム名が使われる。 No
property verifyproperty属性の値により、二つの意味に解釈される。
verifyproperty属性を設定していない場合、生成したチェックサムの値が格納されるプロパティの名前を意味する。
verifyproperty属性を設定している場合、期待するチェックサムの値を意味する(値そのものであり、格納しておくプロパティの名前ではない)。
fileext を指定した場合や、ファイルが複数ある場合は、指定できない。
No
totalproperty 全体のチェックサムを格納するプロパティの名前を指定する。 全体のチェックサムは、それぞれのファイルのチェックサムと、ファイルセットからの相対パスを用いて算出する (可搬性のため、パス中のファイルセパレータは計算の前に'/'に置き換えられる)。 Ant 1.6 〜 No
forceoverwrite 出力先のファイルが新しい場合でも、ファイルを上書きする。デフォルトは "no"。 No
verifyproperty 生成されたチェックサムが期待したものと一致したかどうか( "true" または "false") を格納するプロパティの名前を指定する。
これが設定されている場合、 file属性 や property属性 は、生成されたチェックサムを格納するのではなく、 生成されたチェックサムと比較する目的で使われる。
No
readbuffersize ファイル読み込みに使われるバッファのサイズ(バイト)。 デフォルトは"8192"。 サイズを大きくすると、大きいファイルに対して性能がよくなる可能性がある。 No

Parameters specified as nested elements

内部要素として指定するパラメータ

fileset

FileSets are used to select files to generate checksums for.

FileSetsを用いて、 チェックサムを生成するファイルを指定します。

Examples

Example 1

例 1

<checksum file="foo.bar"/>

Generates a MD5 checksum for foo.bar and stores the checksum in the destination file foo.bar.MD5. foo.bar.MD5 is overwritten only if foo.bar is newer than itself.

foo.bar の MD5 チェックサムを生成し、ファイル foo.bar.MD5 に保存します。 foo.bar の方が新しい場合のみ、foo.bar.MD5 は上書きされます。

Example 2

例 2

<checksum file="foo.bar" forceOverwrite="yes"/>

Generates a MD5 checksum for foo.bar and stores the checksum in foo.bar.MD5. If foo.bar.MD5 already exists, it is overwritten.

foo.bar の MD5 チェックサムを生成し、ファイル foo.bar.MD5 に保存します。 foo.bar.MD5 が存在する場合、上書きされます。

Example 3

例 3

<checksum file="foo.bar" property="foobarMD5"/>

Generates a MD5 checksum for foo.bar and stores it in the Project Property foobarMD5.

foo.bar の MD5 チェックサムを生成し、foobarMD5 プロパティに格納します。

Example 4

例 4

<checksum file="foo.bar" verifyProperty="isMD5ok"/>

Generates a MD5 checksum for foo.bar, compares it against foo.bar.MD5 and sets isMD5ok to either true or false, depending upon the result.

foo.bar の MD5 チェックサムを生成し、foo.bar.MD5と比較し、 その結果 (true か false) を isMD5ok に格納します。

Example 5

例 5

<checksum file="foo.bar" algorithm="SHA" fileext="asc"/>

Generates a SHA checksum for foo.bar and stores the checksum in the destination file foo.bar.asc. foo.bar.asc is overwritten only if foo.bar is newer than itself.

foo.bar の SHA チェックサムを生成し、ファイル foo.bar.asc に保存します。 foo.bar の方が新しい場合のみ、foo.bar.asc は上書きされます。

Example 6

例 6

<checksum file="foo.bar" property="${md5}" verifyProperty="isEqual"/>

Generates a MD5 checksum for foo.bar, compares it against the value of the property md5, and sets isEqual to either true or false, depending upon the result.

foo.bar の MD5 チェックサムを生成し、md5 プロパティの値と比較し、 その結果 (true か false) を isEqual に格納します。

Example 7

例 7

<checksum>
  <fileset dir=".">
    <include name="foo*"/>
  </fileset>
</checksum>

Works just like Example 1, but generates a .MD5 file for every file that begins with the name foo.

例 1 のように動作しますが、 foo ではじまる名前のファイル全てに対し .MD5 ファイルを生成します。

Example 8

例 8

<condition property="isChecksumEqual">
  <checksum>
    <fileset dir=".">
      <include name="foo.bar"/>
    </fileset>
  </checksum>
</condition>

Works like Example 4, but only sets isChecksumEqual to true, if the checksum matches - it will never be set to false. This example demonstrates use with the Condition task.

例4のように動作しますが、チェックサムが一致した場合のみ、 isChecksumEqual を true に設定します ―― 決して false には設定されません。 この例では condition タスクの使用例を示しています。

Note:

注意:

When working with more than one file, if condition and/or verifyproperty is used, the result will be true only if the checksums matched correctly for all files being considered.

複数のファイルに対して condition および/または verifyproperty を用いた場合、 考えられる全てのファイルに対してチェックサムが正しくマッチした場合にのみ、 結果は true となります。


Copyright © 2001-2004 The Apache Software Foundation. All rights Reserved.
[訳注:これは漆島賢二の訳を参考に、的場が翻訳しました。日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]