Deflater (Java Platform SE 7)

java.lang.Object
- java.util.zip.Deflater

public class Deflater
extends Object

このクラスは、一般的な ZLIB 圧縮ライブラリを使用して汎用の圧縮アルゴリズムをサポートします。ZLIB 圧縮ライブラリは、当初 PNG グラフィック標準の一部として開発されたもので、特許では保護されていません。詳細については「パッケージ java.util.zip の説明」の仕様を参照してください。

次に、Deflater および Inflater を使用して文字列をいくらか圧縮および圧縮解除するコードを示します。

 try {
     // Encode a String into bytes
     String inputString = "blahblahblah";
     byte[] input = inputString.getBytes("UTF-8");

     // Compress the bytes
     byte[] output = new byte[100];
     Deflater compresser = new Deflater();
     compresser.setInput(input);
     compresser.finish();
     int compressedDataLength = compresser.deflate(output);
     compresser.end();

     // Decompress the bytes
     Inflater decompresser = new Inflater();
     decompresser.setInput(output, 0, compressedDataLength);
     byte[] result = new byte[100];
     int resultLength = decompresser.inflate(result);
     decompresser.end();

     // Decode the bytes into a String
     String outputString = new String(result, 0, resultLength, "UTF-8");
 } catch(java.io.UnsupportedEncodingException ex) {
     // handle
 } catch (java.util.zip.DataFormatException ex) {
     // handle
 }

関連項目:: Inflater

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static int`	`BEST_COMPRESSION` 最適な圧縮のための圧縮レベルです。
`static int`	`BEST_SPEED` 最高速での圧縮のための圧縮レベルです。
`static int`	`DEFAULT_COMPRESSION` デフォルトの圧縮レベルです。
`static int`	`DEFAULT_STRATEGY` デフォルトの圧縮方法です。
`static int`	`DEFLATED` deflate アルゴリズムのための圧縮メソッド (現在サポートされているのは 1 つだけ) です。
`static int`	`FILTERED` 小さい値がある程度ランダムに分布しているデータに最適な圧縮方法です。
`static int`	`FULL_FLUSH` 保留中のすべての出力をフラッシュし、デフレータをリセットするために使用される圧縮フラッシュモードです。
`static int`	`HUFFMAN_ONLY` ハフマン符号化だけのための圧縮方法です。
`static int`	`NO_COMPRESSION` 圧縮しない場合の圧縮レベルです。
`static int`	`NO_FLUSH` 最高の圧縮結果を実現するために使用される圧縮フラッシュモードです。
`static int`	`SYNC_FLUSH` 保留中のすべての出力をフラッシュするために使用される圧縮フラッシュモードで、一部の圧縮アルゴリズムでは圧縮率が低下することがあります。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`Deflater()` デフォルトの圧縮レベルで新しいコンプレッサを作成します。
`Deflater(int level)` 指定された圧縮レベルで新しいコンプレッサを作成します。
`Deflater(int level, boolean nowrap)` 指定された圧縮レベルで新しいコンプレッサを作成します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`int`	`deflate(byte[] b)` 入力データを圧縮し、指定されたバッファーに圧縮されたデータを挿入します。
`int`	`deflate(byte[] b, int off, int len)` 入力データを圧縮し、指定されたバッファーに圧縮されたデータを挿入します。
`int`	`deflate(byte[] b, int off, int len, int flush)` 入力データを圧縮し、指定されたバッファーに圧縮されたデータを挿入します。
`void`	`end()` コンプレッサを閉じ、圧縮解除された入力をすべて破棄します。
`protected void`	`finalize()` ガベージコレクションが行われたときにコンプレッサを閉じます。
`void`	`finish()` このメソッドが呼び出されると、圧縮が入力バッファーの現在の内容で終了する必要があることを示します。
`boolean`	`finished()` 圧縮データ出力ストリームの最後に達した場合に true を返します。
`int`	`getAdler()` 圧縮解除データの ADLER-32 値を返します。
`long`	`getBytesRead()` これまでに入力された、圧縮解除されたバイトの総数を返します。
`long`	`getBytesWritten()` これまでに出力された、圧縮されたバイトの総数を返します。
`int`	`getTotalIn()` これまでに入力された、圧縮解除されたバイトの総数を返します。
`int`	`getTotalOut()` これまでに出力された、圧縮されたバイトの総数を返します。
`boolean`	`needsInput()` 入力データバッファーが空なので、さらに入力を提供するために setInput() を呼び出す必要がある場合に true を返します。
`void`	`reset()` 新しい入力データのセットを処理できるようにデフレータをリセットします。
`void`	`setDictionary(byte[] b)` 圧縮のためのプリセットディクショナリを設定します。
`void`	`setDictionary(byte[] b, int off, int len)` 圧縮のためのプリセットディクショナリを設定します。
`void`	`setInput(byte[] b)` 圧縮のための入力データを設定します。
`void`	`setInput(byte[] b, int off, int len)` 圧縮のための入力データを設定します。
`void`	`setLevel(int level)` 現在の圧縮レベルに、指定された値を設定します。
`void`	`setStrategy(int strategy)` 圧縮方法を指定された値に設定します。

クラス java.lang.Object から継承されたメソッド
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - DEFLATED
```
public static final int DEFLATED
```
    deflate アルゴリズムのための圧縮メソッド (現在サポートされているのは 1 つだけ) です。
    
    関連項目:
    定数フィールド値
  - NO_COMPRESSION
```
public static final int NO_COMPRESSION
```
    圧縮しない場合の圧縮レベルです。
    
    関連項目:
    定数フィールド値
  - BEST_SPEED
```
public static final int BEST_SPEED
```
    最高速での圧縮のための圧縮レベルです。
    
    関連項目:
    定数フィールド値
  - BEST_COMPRESSION
```
public static final int BEST_COMPRESSION
```
    最適な圧縮のための圧縮レベルです。
    
    関連項目:
    定数フィールド値
  - DEFAULT_COMPRESSION
```
public static final int DEFAULT_COMPRESSION
```
    デフォルトの圧縮レベルです。
    
    関連項目:
    定数フィールド値
  - FILTERED
```
public static final int FILTERED
```
    小さい値がある程度ランダムに分布しているデータに最適な圧縮方法です。ハフマンコーディングを増やし、文字列マッチングを減らします。
    
    関連項目:
    定数フィールド値
  - HUFFMAN_ONLY
```
public static final int HUFFMAN_ONLY
```
    ハフマン符号化だけのための圧縮方法です。
    
    関連項目:
    定数フィールド値
  - DEFAULT_STRATEGY
```
public static final int DEFAULT_STRATEGY
```
    デフォルトの圧縮方法です。
    
    関連項目:
    定数フィールド値
  - NO_FLUSH
```
public static final int NO_FLUSH
```
    最高の圧縮結果を実現するために使用される圧縮フラッシュモード。
    
    導入されたバージョン:
    
    1.7
    
    関連項目:
    deflate(byte[], int, int, int)、定数フィールド値
  - SYNC_FLUSH
```
public static final int SYNC_FLUSH
```
    保留中のすべての出力をフラッシュするために使用される圧縮フラッシュモードで、一部の圧縮アルゴリズムでは圧縮率が低下することがあります。
    
    導入されたバージョン:
    
    1.7
    
    関連項目:
    deflate(byte[], int, int, int)、定数フィールド値
  - FULL_FLUSH
```
public static final int FULL_FLUSH
```
    保留中のすべての出力をフラッシュし、デフレータをリセットするために使用される圧縮フラッシュモード。このモードを頻繁に使用すると、圧縮率が著しく低下することがあります。
    
    導入されたバージョン:
    
    1.7
    
    関連項目:
    deflate(byte[], int, int, int)、定数フィールド値
- コンストラクタの詳細
  - Deflater
```
public Deflater(int level,
        boolean nowrap)
```
    指定された圧縮レベルで新しいコンプレッサを作成します。パラメータ nowrap が true の場合、ZLIB ヘッダーフィールドおよびチェックサムフィールドは、GZIP および PKZIP の両方で使用される圧縮形式のサポートには使用されません。
    
    パラメータ:
    level - 圧縮レベル (0 - 9)
    nowrap - true の場合は GZIP 互換の圧縮を使用
  - Deflater
```
public Deflater(int level)
```
    指定された圧縮レベルで新しいコンプレッサを作成します。圧縮データは ZLIB 形式で生成されます。
    
    パラメータ:
    level - 圧縮レベル (0 - 9)
  - Deflater
```
public Deflater()
```
    デフォルトの圧縮レベルで新しいコンプレッサを作成します。圧縮データは ZLIB 形式で生成されます。
- メソッドの詳細
  - setInput
```
public void setInput(byte[] b,
            int off,
            int len)
```
    圧縮のための入力データを設定します。needsInput() でさらに入力が必要であることを示す true が返されるときは、このメソッドを呼び出す必要があります。
    
    パラメータ:
    b - 入力データバイト
    off - データの開始オフセット
    len - データの長さ
    関連項目:
    needsInput()
  - setInput
```
public void setInput(byte[] b)
```
    圧縮のための入力データを設定します。needsInput() でさらに入力が必要であることを示す true が返されるときは、このメソッドを呼び出す必要があります。
    
    パラメータ:
    b - 入力データバイト
    関連項目:
    needsInput()
  - setDictionary
```
public void setDictionary(byte[] b,
                 int off,
                 int len)
```
    圧縮のためのプリセットディクショナリを設定します。プリセットディクショナリは、履歴バッファーがあらかじめ決定できるときに使用されます。データがあとで Inflater.inflate() によって圧縮解除されるときに、Inflater.getAdler() を呼び出して圧縮解除に必要なディクショナリの Adler-32 値を取得できます。
    
    パラメータ:
    b - ディクショナリデータバイト
    off - データの開始オフセット
    len - データの長さ
    関連項目:
    Inflater.inflate(byte[], int, int), Inflater.getAdler()
  - setDictionary
```
public void setDictionary(byte[] b)
```
    圧縮のためのプリセットディクショナリを設定します。プリセットディクショナリは、履歴バッファーがあらかじめ決定できるときに使用されます。データがあとで Inflater.inflate() によって圧縮解除されるときに、Inflater.getAdler() を呼び出して圧縮解除に必要なディクショナリの Adler-32 値を取得できます。
    
    パラメータ:
    b - ディクショナリデータバイト
    関連項目:
    Inflater.inflate(byte[], int, int), Inflater.getAdler()
  - setStrategy
```
public void setStrategy(int strategy)
```
    圧縮方法を指定された値に設定します。
    
    パラメータ:
    strategy - 新しい圧縮方法
    
    例外:
    
    IllegalArgumentException - 圧縮方法が無効な場合
  - setLevel
```
public void setLevel(int level)
```
    現在の圧縮レベルに、指定された値を設定します。
    
    パラメータ:
    level - 新しい圧縮レベル (0 - 9)
    
    例外:
    
    IllegalArgumentException - 圧縮レベルが無効な場合
  - needsInput
```
public boolean needsInput()
```
    入力データバッファーが空なので、さらに入力を提供するために setInput() を呼び出す必要がある場合に true を返します。
    
    戻り値:
    入力データバッファーが空なので、さらに入力を提供するために setInput() を呼び出す必要がある場合は true
  - finish
```
public void finish()
```
    このメソッドが呼び出されると、圧縮が入力バッファーの現在の内容で終了する必要があることを示します。
  - finished
```
public boolean finished()
```
    圧縮データ出力ストリームの最後に達した場合に true を返します。
    
    戻り値:
    圧縮データ出力ストリームの最後に達した場合は true
  - deflate
```
public int deflate(byte[] b,
          int off,
          int len)
```
    入力データを圧縮し、指定されたバッファーに圧縮されたデータを挿入します。実際に圧縮されたデータのバイト数を返します。戻り値 0 は、入力データがさらに必要かどうかを判断するために needsInput を呼び出す必要があることを示します。
    このメソッドは、その圧縮フラッシュモードとして NO_FLUSH を使用します。形式 deflater.deflate(b, off, len) のこのメソッドの呼び出しでは、deflater.deflate(b, off, len, Deflater.NO_FLUSH) の呼び出しと同じ結果が得られます。
    
    パラメータ:
    b - 圧縮データ用のバッファー
    off - データの開始オフセット
    len - 圧縮データの最大バイト数
    
    戻り値:
    出力バッファーに書き込まれた圧縮データの実際のバイト数
  - deflate
```
public int deflate(byte[] b)
```
    入力データを圧縮し、指定されたバッファーに圧縮されたデータを挿入します。実際に圧縮されたデータのバイト数を返します。戻り値 0 は、入力データがさらに必要かどうかを判断するために needsInput を呼び出す必要があることを示します。
    このメソッドは、その圧縮フラッシュモードとして NO_FLUSH を使用します。形式 deflater.deflate(b) のこのメソッドの呼び出しでは、deflater.deflate(b, 0, b.length, Deflater.NO_FLUSH) の呼び出しと同じ結果が得られます。
    
    パラメータ:
    b - 圧縮データ用のバッファー
    
    戻り値:
    出力バッファーに書き込まれた圧縮データの実際のバイト数
  - deflate
```
public int deflate(byte[] b,
          int off,
          int len,
          int flush)
```
    入力データを圧縮し、指定されたバッファーに圧縮されたデータを挿入します。実際に圧縮されたデータのバイト数を返します。
    圧縮フラッシュモードは、次の 3 つのモードのいずれかになります。
    - NO_FLUSH: 最高の圧縮を達成するために、デフレータが出力を生成するまでに蓄積されるデータの量を決定できるようにします (通常の使用シナリオで使用する)。このフラッシュモードでの戻り値 0 は、入力データがさらに必要かどうかを判断するために needsInput() を呼び出すべきであることを示します。
    - SYNC_FLUSH: 圧縮されたデータに機能するインフレータがそれまでに使用可能なすべての入力データを取得できるようにするため、デフレータのすべての保留中の出力が指定された出力バッファーにフラッシュされます (特に、needsInput() は十分な出力スペースが提供されている場合、この呼び出しのあとに true を返す)。SYNC_FLUSH を使用してフラッシュすると、一部の圧縮アルゴリズムで圧縮率が低下することがあるため、これは必要な場合にのみ使用してください。
    - FULL_FLUSH: SYNC_FLUSH と同じように、すべての保留中の出力がフラッシュされます。圧縮状態がリセットされるため、圧縮された出力データに機能するインフレータは、前の圧縮データが破損したか、ランダムアクセスが要求されている場合に、このポイントから再開できます。FULL_FLUSH を頻繁に使用すると、圧縮率が著しく低下することがあります。
    FULL_FLUSH または SYNC_FLUSH の例で、戻り値が len (出力バッファー b の使用可能な領域) の場合、このメソッドは同じ flush パラメータともっと大きな出力領域で再度呼び出してください。
    パラメータ:
    b - 圧縮データ用のバッファー
    off - データの開始オフセット
    len - 圧縮データの最大バイト数
    flush - 圧縮フラッシュモード
    
    戻り値:
    出力バッファーに書き込まれた圧縮データの実際のバイト数
    
    例外:
    
    IllegalArgumentException - フラッシュモードが無効な場合
    導入されたバージョン:
    
    1.7
  - getAdler
```
public int getAdler()
```
    圧縮解除データの ADLER-32 値を返します。
    
    戻り値:
    圧縮解除データの ADLER-32 値
  - getTotalIn
```
public int getTotalIn()
```
    これまでに入力された、圧縮解除されたバイトの総数を返します。
    バイト数は Integer.MAX_VALUE よりも大きくなる場合があるため、この情報を得る場合は getBytesRead() メソッドの方を優先的に使用してください。
    
    戻り値:
    これまでに入力された、圧縮解除されたバイトの総数
  - getBytesRead
```
public long getBytesRead()
```
    これまでに入力された、圧縮解除されたバイトの総数を返します。
    
    戻り値:
    これまでに入力された、圧縮解除されたバイトの総数 (負ではない値)
    導入されたバージョン:
    
    1.5
  - getTotalOut
```
public int getTotalOut()
```
    これまでに出力された、圧縮されたバイトの総数を返します。
    バイト数は Integer.MAX_VALUE よりも大きくなる場合があるため、この情報を得る場合は getBytesWritten() メソッドの方を優先的に使用してください。
    
    戻り値:
    これまでに出力された、圧縮されたバイトの総数
  - getBytesWritten
```
public long getBytesWritten()
```
    これまでに出力された、圧縮されたバイトの総数を返します。
    
    戻り値:
    これまでに出力された、圧縮されたバイトの総数 (負ではない値)
    導入されたバージョン:
    
    1.5
  - reset
```
public void reset()
```
    新しい入力データのセットを処理できるようにデフレータをリセットします。現在の圧縮レベルと圧縮方法を保持します。
  - end
```
public void end()
```
    コンプレッサを閉じ、圧縮解除された入力をすべて破棄します。このメソッドは、コンプレッサを使用しなくなったときに呼び出す必要がありますが、finalize() メソッドによっても自動的に呼び出されます。このメソッドが呼び出されたあとの Deflater オブジェクトの動作は保証されません。
  - finalize
```
protected void finalize()
```
    ガベージコレクションが行われたときにコンプレッサを閉じます。
    
    オーバーライド:
    
    finalize、クラス: Object

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス Deflater

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

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

フィールドの詳細

DEFLATED

NO_COMPRESSION

BEST_SPEED

BEST_COMPRESSION

DEFAULT_COMPRESSION

FILTERED

HUFFMAN_ONLY

DEFAULT_STRATEGY

NO_FLUSH

SYNC_FLUSH

FULL_FLUSH

コンストラクタの詳細

Deflater

Deflater

Deflater

メソッドの詳細

setInput

setInput

setDictionary

setDictionary

setStrategy

setLevel

needsInput

finish

finished

deflate

deflate

deflate

getAdler

getTotalIn

getBytesRead

getTotalOut

getBytesWritten

reset

end

finalize