Класс 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
}

Поля

DEFLATED

public static final int DEFLATED

Метод сжатия для алгоритма deflate (единственный поддерживаемый в настоящее время).

См. также:

Значения константных полей

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()

Возвращает true, если буфер входных данных пуст и следует вызвать setInput() для предоставления дополнительных входных данных.

Возвращает:

true, если буфер входных данных пуст и следует вызвать setInput() для предоставления дополнительных входных данных

finish

public void finish()

При вызове указывает, что сжатие должно завершиться текущим содержимым буфера входных данных.

finished

public boolean finished()

Возвращает true, если достигнут конец потока вывода сжатых данных.

Возвращает:

true, если достигнут конец потока вывода сжатых данных

deflate

public int deflate(byte[] b,
                   int off,
                   int len)

Параметры:

b - буфер для сжатых данных

off - начальный смещение данных

len - максимальное количество байтов сжатых данных

Возвращает:

фактическое количество байтов сжатых данных, записанных в буфер вывода

deflate

public int deflate(byte[] b)

Параметры:

b - буфер для сжатых данных

Возвращает:

фактическое количество байтов сжатых данных, записанных в буфер вывода

deflate

public int deflate(byte[] b,
                   int off,
                   int len,
                   int flush)

Параметры:

b - буфер для сжатых данных

off - начальный смещение данных

len - максимальное количество байтов сжатых данных

flush - режим сжатия flush

Возвращает:

фактическое количество байтов сжатых данных, записанных в буфер вывода

Исключения:

IllegalArgumentException - если режим flush некорректен

С версии:

1.7

getAdler

public int getAdler()

Возвращает значение ADLER-32 нескомпрессированных данных.

Возвращает:

значение ADLER-32 нескомпрессированных данных

getTotalIn

public int getTotalIn()

Возвращает:

общее количество нескомпрессированных байтов, введенных до сих пор

getBytesRead

public long getBytesRead()

Возвращает общее количество нескомпрессированных байтов, введенных до сих пор.

Возвращает:

общее (неотрицательное) количество нескомпрессированных байтов, введенных до сих пор

С версии:

1.5

getTotalOut

public int getTotalOut()

Возвращает:

общее количество сжатых байтов, выведенных до сих пор

getBytesWritten

public long getBytesWritten()

Возвращает общее количество сжатых байтов, выведенных до сих пор.

Возвращает:

общее (неотрицательное) количество сжатых байтов, выведенных до сих пор

С версии:

1.5

reset

public void reset()

Сбрасывает сжатие, чтобы можно было обработать новый набор входных данных. Сохраняет текущие настройки уровня и стратегии сжатия.

end

public void end()

Закрывает компрессор и отбрасывает все необработанные входные данные. Этот метод следует вызывать, когда компрессор больше не используется, но также будет вызван автоматически методом finalize(). После вызова этого метода поведение объекта Deflater неопределено.

finalize

protected void finalize()

Закрывает компрессор при сборке мусора.

Переопределяет:

finalize в классе Object

См. также:

WeakReference, PhantomReference