Класс Deflater

public static final int DEFLATED

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

public static final int NO_COMPRESSION

Уровень сжатия для отсутствия сжатия.

public static final int BEST_SPEED

Уровень сжатия для самого быстрого сжатия.

public static final int BEST_COMPRESSION

Уровень сжатия для наилучшего сжатия.

public static final int DEFAULT_COMPRESSION

Уровень сжатия по умолчанию.

public static final int FILTERED

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

public static final int HUFFMAN_ONLY

Стратегия сжатия, использующая только кодирование Хаффмана.

public static final int DEFAULT_STRATEGY

Стратегия сжатия по умолчанию.

public static final int NO_FLUSH

Режим сброса сжатия, используемый для достижения наилучшего результата сжатия.

public static final int SYNC_FLUSH

Режим сброса сжатия, используемый для вывода всех ожидаемых выходных данных; может ухудшить сжатие для некоторых алгоритмов сжатия.

public static final int FULL_FLUSH

Режим сброса сжатия, используемый для вывода всех ожидаемых выходных данных и сброса сжимающего модуля. Использование этого режима слишком часто может серьезно ухудшить сжатие.

public Deflater(int level, boolean nowrap)

Создаёт новый сжимающий модуль, используя указанный уровень сжатия. Если 'nowrap' имеет значение true, то заголовки и контрольные суммы ZLIB не будут использоваться для поддержки формата сжатия, используемого как в GZIP, так и в PKZIP.

public Deflater(int level)

Создаёт новый сжимающий модуль, используя указанный уровень сжатия. Сжатые данные будут генерироваться в формате ZLIB.

public Deflater()

Создаёт новый сжимающий модуль с уровнем сжатия по умолчанию. Сжатые данные будут генерироваться в формате ZLIB.

public void setInput(byte[] input, int off, int len)

Устанавливает входные данные для сжатия.

Один из методов setInput() должен вызываться всякий раз, когда needsInput() возвращает true, указывающее на то, что требуется больше входных данных.

public void setInput(byte[] input)

Устанавливает входные данные для сжатия.

Один из методов setInput() должен вызываться всякий раз, когда needsInput() возвращает true, указывающее на то, что требуется больше входных данных.

public void setInput(ByteBuffer input)

Устанавливает входные данные для сжатия.

Один из методов setInput() должен вызываться всякий раз, когда needsInput() возвращает true, указывающее на то, что требуется больше входных данных.

Позиция заданного буфера будет перемещена по мере выполнения операций сжатия deflate, до предела буфера. Входной буфер можно изменять (пополнять) между операциями сжатия; это эквивалентно созданию нового буфера и его установке с помощью этого метода.

Изменение содержимого, позиции или предела входного буфера одновременно с операцией сжатия deflate приведёт к неопределённому поведению, что может включать неправильные результаты операции или сбой операции.

public void setDictionary(byte[] dictionary, int off, int len)

Устанавливает предопределённый словарь для сжатия. Предварительно заданный словарь используется, когда буфер истории можно определить заранее. Когда данные позже распаковываются с помощью Inflater.inflate(), Inflater.getAdler() можно вызвать для получения значения Adler-32 словаря, необходимого для распаковки.

public void setDictionary(byte[] dictionary)

Устанавливает предопределённый словарь для сжатия. Предварительно заданный словарь используется, когда буфер истории можно определить заранее. Когда данные позже распаковываются с помощью Inflater.inflate(), Inflater.getAdler() можно вызвать для получения значения Adler-32 словаря, необходимого для распаковки.

public void setDictionary(ByteBuffer dictionary)

Устанавливает предопределённый словарь для сжатия. Предварительно заданный словарь используется, когда буфер истории можно определить заранее. Когда данные позже распаковываются с помощью Inflater.inflate(), Inflater.getAdler() можно вызвать для получения значения Adler-32 словаря, необходимого для распаковки.

Байты в заданном буфере будут полностью использованы этим методом. По возвращении его позиция будет равна его пределу.

public void setStrategy(int strategy)

Устанавливает стратегию сжатия до указанного значения.

Если стратегия сжатия изменена, следующий вызов deflate будет сжимать доступный на данный момент входной поток со старой стратегией (и, возможно, сброшен); новая стратегия вступит в силу только после этого вызова.

public void setLevel(int level)

Устанавливает уровень сжатия до указанного значения.

Если уровень сжатия изменён, следующий вызов deflate будет сжимать доступный на данный момент входной поток со старым уровнем (и, возможно, сброшен); новый уровень вступит в силу только после этого вызова.

public boolean needsInput()

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

public void finish()

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

public boolean finished()

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

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

Сжимает данные ввода и заполняет указанный буфер сжатыми данными. Возвращает фактическое количество байт сжатых данных. Значение 0 указывает, что необходимо вызвать needsInput для определения, требуется ли дополнительный входной данные.

Этот метод использует NO_FLUSH в качестве режима сброса сжатия. Вызов этого метода в виде deflater.deflate(b, off, len) даёт тот же результат, что и вызов deflater.deflate(b, off, len, Deflater.NO_FLUSH).

public int deflate(byte[] output)

Сжимает данные ввода и заполняет указанный буфер сжатыми данными. Возвращает фактическое количество байт сжатых данных. Значение 0 указывает, что необходимо вызвать needsInput для определения, требуется ли дополнительный входной данные.

Этот метод использует NO_FLUSH в качестве режима сброса сжатия. Вызов этого метода в виде deflater.deflate(b) даёт тот же результат, что и вызов deflater.deflate(b, 0, b.length, Deflater.NO_FLUSH).

public int deflate(ByteBuffer output)

Сжимает данные ввода и заполняет указанный буфер сжатыми данными. Возвращает фактическое количество байт сжатых данных. Значение 0 указывает, что needsInput следует вызвать, чтобы определить, требуется ли дополнительный входной данные.

Этот метод использует NO_FLUSH в качестве режима сброса сжатия. Вызов этого метода в виде deflater.deflate(output) даёт тот же результат, что и вызов deflater.deflate(output, Deflater.NO_FLUSH).

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

Сжимает данные ввода и заполняет указанный буфер сжатыми данными. Возвращает фактическое количество сжатых данных.

Режим сброса сжатия — один из следующих трёх режимов:

• NO_FLUSH: позволяет сжимаемому модулю определить, сколько данных накопить, прежде чем произвести вывод, для достижения наилучшего сжатия (следует использовать в обычном сценарии). Значение 0 в этом режиме сброса указывает, что необходимо вызвать needsInput() для определения, требуется ли дополнительный входной данные.
• SYNC_FLUSH: все ожидающие выходные данные в сжимающем модуле сбрасываются в указанный буфер вывода, чтобы сжимающий модуль смог получить все доступные входные данные (в частности, needsInput() возвращает true после этого вызова, если предоставлено достаточно места в буфере вывода). Сброс с SYNC_FLUSH может ухудшить сжатие для некоторых алгоритмов сжатия, и поэтому его следует использовать только при необходимости.
• FULL_FLUSH: все ожидающие выходные данные сбрасываются, как и с SYNC_FLUSH. Состояние сжатия сбрасывается, чтобы сжимающий модуль мог перезапустить процесс от этой точки, если предыдущие сжатые данные были повреждены или требуется произвольный доступ. Чрезмерное использование FULL_FLUSH может серьёзно ухудшить сжатие.

В случае FULL_FLUSH или SYNC_FLUSH, если возвращаемое значение равно len, доступное место в буфере вывода b, необходимо повторно вызвать этот метод с тем же параметром flush и большим количеством места в буфере вывода. Убедитесь, что len больше 6, чтобы избежать повторного вывода маркера сброса (5 байт) в буфер вывода при каждом вызове этого метода.

Если метод setInput(ByteBuffer) был вызван для предоставления буфера ввода, позиция буфера ввода будет смещена на количество байт, потреблённых этим операцией.

public int deflate(ByteBuffer output, int flush)

Сжимает данные ввода и заполняет указанный буфер сжатыми данными. Возвращает фактическое количество сжатых данных.

Режим сброса сжатия — один из следующих трёх режимов:

• NO_FLUSH: позволяет сжимаемому модулю определить, сколько данных накопить, прежде чем произвести вывод, для достижения наилучшего сжатия (следует использовать в обычном сценарии). Возврат 0 в этом режиме указывает, что следует вызвать needsInput() для определения, требуется ли дополнительный входной данные.
• SYNC_FLUSH: все ожидающие выходные данные в сжимающем модуле сбрасываются в указанный буфер вывода, чтобы сжимающий модуль смог получить все доступные входные данные (в частности, needsInput() возвращает true после этого вызова, если предоставлено достаточно места в буфере вывода). Сброс с SYNC_FLUSH может ухудшить сжатие для некоторых алгоритмов сжатия, и поэтому его следует использовать только при необходимости.
• FULL_FLUSH: все ожидающие выходные данные сбрасываются, как и с SYNC_FLUSH. Состояние сжатия сбрасывается, чтобы сжимающий модуль мог перезапустить процесс от этой точки, если предыдущие сжатые данные были повреждены или требуется произвольный доступ. Чрезмерное использование FULL_FLUSH может серьёзно ухудшить сжатие.

В случае FULL_FLUSH или SYNC_FLUSH, если возвращаемое значение равно оставшемуся месту в буфере, этот метод следует вызвать снова с тем же параметром flush и большим объемом пространства в буфере. Убедитесь, что буфер имеет не менее 6 байт оставшегося места, чтобы избежать повторного вывода маркера сброса (5 байт) в буфер вывода при каждом вызове этого метода.

При успешном выполнении позиция данного буфера байт output будет смещена на количество байтов, произведённых операцией, что равно возвращаемому значению этого метода.

Если метод setInput(ByteBuffer) был вызван для предоставления буфера ввода, позиция буфера ввода будет смещена на количество байт, потреблённых этой операцией.

public int getAdler()

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

public int getTotalIn()

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

Поскольку количество байтов может быть больше, чем Integer.MAX_VALUE, метод getBytesRead() сейчас является предпочтительным способом получения этой информации.

public long getBytesRead()

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

public int getTotalOut()

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

Поскольку количество байтов может быть больше, чем Integer.MAX_VALUE, метод getBytesWritten() сейчас является предпочтительным способом получения этой информации.

public long getBytesWritten()

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

public void reset()

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

public void end()

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