org.opengion.fukurou.util

## クラス ZipArchive

- java.lang.Object
- - org.opengion.fukurou.util.ZipArchive

-     public final class ZipArchive
      extends Object

       ZipArchive.java は、ZIPファイルの解凍・圧縮を行うためのUtilクラスです。

       zipファイルで、圧縮時のファイルのエンコードを指定できるようにします。
       ファイルをZIPにするには、java.util.zipパッケージ を利用するのが一般的です。
       ところが、ファイル名にUTF-8文字エンコーディングを利用する為、Windowsの世界では
       これを取り扱うアプリケーションも少ないため、文字化けして見えてしまいます。
       これを解決するには、エンコードが指定できるアーカイバをる要する必要があります。
       有名どころでは、ant.jar に含まれる、org.apache.tools.zip と、Apache Commons の
       org.apache.commons.compress です。
       org.apache.tools.zip は、java.util.zip とほぼ同じ扱い方、クラス名が使えるので
       既存のアプリケーションを作り変えるには、最適です。
       openGion では、アーカイバ専用ということで、org.apache.commons.compress を
       採用します。

  変更履歴:

    6.0.0.0 (2014/04/11) org.apache.commons.compress パッケージの利用(日本語ファイル名対応)

  機能分類
    ユーティリティ
  バージョン
    6.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### メソッドのサマリー

    すべてのメソッド staticメソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `static List` | `compress(File[] files, File zipFile)` 引数に指定されたファイル又はフィルダ内に存在するファイルをZIPファイルに圧縮します。
    `static List` | `compress(File[] files, File zipFile, String encording)` 引数に指定されたファイル又はフィルダ内に存在するファイルをZIPファイルに圧縮します。
    `static List` | `compress(File dir, File zipFile)` 引数に指定されたファイル又はフィルダ内に存在するファイルをZIPファイルに圧縮します。
    `static void` | `main(String[] args)` ファイルの圧縮または解凍を行います。
    `static List` | `unCompress(File targetPath, File zipFile)` エンコードに、Windows-31J を指定した、ZIPファイルの解凍処理を行います。
    `static List` | `unCompress(File targetPath, File zipFile, String encording)` エンコードを指定した、ZIPファイルの解凍処理を行います。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### メソッドの詳細

    - #### unCompress

          public static List unCompress(File targetPath,
                                        File zipFile)

      エンコードに、Windows-31J を指定した、ZIPファイルの解凍処理を行います。 引数にフォルダ(targetPath)に指定されたZIPファイル(zipFile)を解凍します。 解凍先のファイルが存在する場合でも、上書きされますので注意下さい。
      パラメータ:
        `targetPath` - 解凍先のフォルダ
        `zipFile` - 解凍するZIPファイル
      戻り値:
        解凍されたZIPファイルの一覧
      変更履歴:

        5.7.1.2 (2013/12/20) org.apache.commons.compress パッケージの利用(日本語ファイル名対応)

      このメソッドは、nullを返しません

    - #### unCompress

          public static List unCompress(File targetPath,
                                        File zipFile,
                                        String encording)

      エンコードを指定した、ZIPファイルの解凍処理を行います。 引数にフォルダ(targetPath)に指定されたZIPファイル(zipFile)を解凍します。 解凍先のファイルが存在する場合でも、上書きされますので注意下さい。 解凍途中のエラーは、エラー出力に出力するだけで、処理は止めません。
      パラメータ:
        `targetPath` - 解凍先のフォルダ
        `zipFile` - 解凍するZIPファイル
        `encording` - ファイルのエンコード(Windows環境では、"Windows-31J" を指定します)
      戻り値:
        解凍されたZIPファイルの一覧
      変更履歴:

        4.1.0.2 (2008/02/01) 新規追加
        4.3.1.1 (2008/08/23) mkdirs の戻り値判定
        4.3.3.3 (2008/10/22) mkdirsする前に存在チェック
        5.1.9.0 (2010/08/01) 更新時刻の設定
        5.7.1.2 (2013/12/20) org.apache.commons.compress パッケージの利用(日本語ファイル名対応)

      このメソッドは、nullを返しません

    - #### compress

          public static List compress(File[] files,
                                      File zipFile)

      引数に指定されたファイル又はフィルダ内に存在するファイルをZIPファイルに圧縮します。 圧縮レベルはデフォルトのDEFAULT_COMPRESSIONです。 圧縮ファイルのエントリー情報として本来は、圧縮前後のファイルサイズ、変更日時、CRCを登録する 必要がありますが、ここでは高速化のため、設定していません。(特に圧縮後ファイルサイズの取得は、 非常に不可がかかる。) このため、一部のアーカイバでは正しく解凍できない可能性があります。 既にZIPファイルが存在する場合でも、上書きされますので注意下さい。
      パラメータ:
        `files` - 圧縮対象のファイル配列
        `zipFile` - ZIPファイル名
      戻り値:
        ZIPファイルのエントリーファイル名一覧
      変更履歴:

        4.1.0.2 (2008/02/01) 新規追加
        5.7.1.2 (2013/12/20) org.apache.commons.compress パッケージの利用(日本語ファイル名対応)

      このメソッドは、nullを返しません

    - #### compress

          public static List compress(File dir,
                                      File zipFile)

      引数に指定されたファイル又はフィルダ内に存在するファイルをZIPファイルに圧縮します。 圧縮レベルはデフォルトのDEFAULT_COMPRESSIONです。 圧縮ファイルのエントリー情報として本来は、圧縮前後のファイルサイズ、変更日時、CRCを登録する 必要がありますが、ここでは高速化のため、設定していません。(特に圧縮後ファイルサイズの取得は、 非常に不可がかかる。) このため、一部のアーカイバでは正しく解凍できない可能性があります。 既にZIPファイルが存在する場合でも、上書きされますので注意下さい。
      パラメータ:
        `dir` - 圧縮対象のディレクトリか、ファイル
        `zipFile` - ZIPファイル名
      戻り値:
        ZIPファイルのエントリーファイル名一覧
      変更履歴:

        5.7.1.2 (2013/12/20) org.apache.commons.compress パッケージの利用(日本語ファイル名対応)
        6.3.9.0 (2015/11/06) 1行にまとめる。

      このメソッドは、nullを返しません

    - #### compress

          public static List compress(File[] files,
                                      File zipFile,
                                      String encording)

      引数に指定されたファイル又はフィルダ内に存在するファイルをZIPファイルに圧縮します。 圧縮レベルはデフォルトのDEFAULT_COMPRESSIONです。 圧縮ファイルのエントリー情報として本来は、圧縮前後のファイルサイズ、変更日時、CRCを登録する 必要がありますが、ここでは高速化のため、設定していません。(特に圧縮後ファイルサイズの取得は、 非常に不可がかかる。) このため、一部のアーカイバでは正しく解凍できない可能性があります。 既にZIPファイルが存在する場合でも、上書きされますので注意下さい。
      パラメータ:
        `files` - 圧縮対象のファイル配列
        `zipFile` - ZIPファイル名
        `encording` - ファイルのエンコード(Windows環境では、"Windows-31J" を指定します)
      戻り値:
        ZIPファイルのエントリーファイル名一覧
      変更履歴:

        4.1.0.2 (2008/02/01) 新規追加
        5.7.1.2 (2013/12/20) org.apache.commons.compress パッケージの利用(日本語ファイル名対応)
        6.3.9.0 (2015/11/06) null になっている可能性があるメソッドの戻り値のnullチェックを追加。

      このメソッドは、nullを返しません

    - #### main

          public static void main(String[] args)

      ファイルの圧縮または解凍を行います。
      パラメータ:
        `args` - パラメータ
      変更履歴:

        4.1.0.2 (2008/02/01) 新規追加 Usage: java org.opengion.fukurou.util.ZipArchive comp|uncomp targetPath zipFileName 第1引数 : comp:圧縮 uncomp:解凍 第2引数 : ZIPファイル名 第3引数 : 圧縮時:圧縮対象のファイル又はフォルダ 解凍時:解凍先のフォルダ

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.