Класс ImageWriteParam

public static final int MODE_DISABLED

Постоянное значение, которое может быть передано в методы, такие как setTilingMode, setProgressiveMode и setCompressionMode, чтобы отключить функцию для будущих записей. То есть, когда этот режим установлен, поток не будет разбит на плитки, не будет прогрессивным и не будет сжат, а соответствующие методы доступа будут выбрасывать исключение IllegalStateException.

public static final int MODE_DEFAULT

Постоянное значение, которое может быть передано в методы, такие как setTilingMode, setProgressiveMode и setCompressionMode, чтобы включить эту функцию для будущих записей. То есть, при включении этого режима поток будет разбит на плитки, будет прогрессивным или сжатым в соответствии с разумным по умолчанию способом, выбранным внутри писателем в зависимости от плагина, и соответствующие методы доступа будут выбрасывать исключение IllegalStateException.

public static final int MODE_EXPLICIT

Постоянное значение, которое может быть передано в методы, такие как setTilingMode или setCompressionMode, чтобы включить функцию для будущих записей. То есть, когда этот режим установлен, поток будет разбит на плитки или сжат в соответствии с дополнительной информацией, предоставленной соответствующим set методам в этом классе и извлекаемой из соответствующих get методов. Обратите внимание, что этот режим не поддерживается для прогрессивного вывода.

public static final int MODE_COPY_FROM_METADATA

Постоянное значение, которое может быть передано в методы, такие как setTilingMode, setProgressiveMode или setCompressionMode, чтобы включить эту функцию для будущих записей. То есть, когда этот режим включен, поток будет разбит на плитки, прогрессивным или сжатым на основе содержимого потока и/или метаданных изображения, переданных в операцию записи, и любые соответствующие методы доступа будут выбрасывать исключение IllegalStateException.

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

protected boolean canWriteTiles

Значение, которое равно true, если этот ImageWriteParam позволяет установить параметры ширины и высоты плиток. По умолчанию значение равно false. Подклассы должны устанавливать значение вручную.

Подклассы, которые не поддерживают запись плиток, должны убедиться, что это значение установлено в false.

protected int tilingMode

Режим, контролирующий параметры разбиения на плитки, который должен быть установлен на одно из четырех MODE_* значений. Значение по умолчанию — MODE_COPY_FROM_METADATA.

Подклассы, которые не выполняют запись плиток, могут игнорировать это значение.

protected Dimension[] preferredTileSizes

Массив пар диапазонов предпочтительных размеров плиток. Значение по умолчанию — null, что указывает на отсутствие предпочтительных размеров. Если значение отлично от null, оно должно иметь чётную длину не менее двух.

Подклассы, которые не поддерживают запись плиток, могут игнорировать это значение.

protected boolean tilingSet

Значение, которое равно true, если параметры разбиения на плитки были указаны.

Подклассы, которые не поддерживают запись плиток, могут игнорировать это значение.

protected int tileWidth

Ширина каждой плитки, если разбиение на плитки задано, или 0 в противном случае.

Подклассы, которые не поддерживают разбиение на плитки, могут игнорировать это значение.

protected int tileHeight

Высота каждой плитки, если разбиение на плитки задано, или 0 в противном случае. Начальное значение — 0.

Подклассы, которые не поддерживают разбиение на плитки, могут игнорировать это значение.

protected boolean canOffsetTiles

Значение, которое равно true, если этот ImageWriteParam позволяет задавать параметры смещения сетки плиток. По умолчанию значение равно false. Подклассы должны устанавливать значение вручную.

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

protected int tileGridXOffset

Значение смещения начала сетки плиток по горизонтали от начала изображения, если разбиение на плитки задано, или 0 в противном случае. Начальное значение — 0.

Подклассы, которые не поддерживают смещение плиток, могут игнорировать это значение.

protected int tileGridYOffset

Значение смещения начала сетки плиток по вертикали от начала изображения, если разбиение на плитки задано, или 0 в противном случае. Начальное значение — 0.

Подклассы, которые не поддерживают смещение плиток, могут игнорировать это значение.

protected boolean canWriteProgressive

Значение, которое равно true, если этот ImageWriteParam позволяет записывать изображения как прогрессивную последовательность проходов с увеличивающимся качеством. По умолчанию значение равно false. Подклассы должны устанавливать значение вручную.

Подклассы, которые не поддерживают прогрессивное кодирование, должны убедиться, что это значение установлено в false.

protected int progressiveMode

Режим, управляющий прогрессивным кодированием, который должен быть установлен на одно из четырёх MODE_* значений, за исключением MODE_EXPLICIT. По умолчанию используется MODE_COPY_FROM_METADATA.

Подклассы, которые не поддерживают прогрессивное кодирование, могут игнорировать это значение.

protected boolean canWriteCompressed

Флаг, который указывает, boolean ли этот модуль записи способен записывать изображения сжатыми. По умолчанию, значение равно false. Подклассы должны устанавливать значение вручную.

Подклассы, которые не поддерживают сжатие, должны установить это значение в false.

protected int compressionMode

Режим, контролирующий настройки сжатия, который должен быть установлен на одно из четырёх MODE_* значений. По умолчанию используется MODE_COPY_FROM_METADATA.

Подклассы, которые не поддерживают сжатие, могут игнорировать это значение.

protected String[] compressionTypes

Массив String, содержащий названия доступных типов сжатия. Подклассы должны устанавливать значение вручную.

Подклассы, которые не поддерживают сжатие, могут игнорировать это значение.

protected String compressionType

String, содержащий имя текущего типа сжатия, или null, если тип не задан.

Подклассы, которые не поддерживают сжатие, могут игнорировать это значение.

protected float compressionQuality

float, содержащий текущую настройку качества сжатия. Начальное значение равно 1.0F.

Подклассы, которые не поддерживают сжатие, могут игнорировать это значение.

protected Locale locale

Locale для локализации имён типов сжатия и описаний качества, или null для использования по умолчанию Locale. Подклассы должны устанавливать значение вручную.

protected ImageWriteParam()

Создаёт пустой ImageWriteParam. Подклассу необходимо правильно установить переменные экземпляра.

public ImageWriteParam(Locale locale)

Создаёт ImageWriteParam, настроенный на использование заданного Locale.

public Locale getLocale()

Возвращает текущий Locale, или null, если поддерживается только по умолчанию Locale.

public boolean canWriteTiles()

Возвращает true, если модуль записи может выполнять разбиение на плитки при записи. Если этот метод возвращает false, то setTiling выбросит UnsupportedOperationException.

public boolean canOffsetTiles()

Возвращает true, если модуль записи может выполнять разбиение на плитки с неравными отступами в сетке во время записи. Если этот метод возвращает false, то setTiling выбросит UnsupportedOperationException, если аргументы смещения сетки не равны нулю. Если canWriteTiles возвращает false, этот метод также вернёт false.

public void setTilingMode(int mode)

Определяет, будет ли изображение разбит на плитки в выходном потоке и, если да, то как будут определены параметры разбиения. Режимы интерпретируются следующим образом:

• MODE_DISABLED - Изображение не будет разбито на плитки. setTiling выбросит IllegalStateException.
• MODE_DEFAULT - Изображение будет разбито на плитки с использованием параметров по умолчанию. setTiling выбросит IllegalStateException.
• MODE_EXPLICIT - Изображение будет разбито на плитки в соответствии с параметрами, указанными в методе setTiling. Все ранее заданные параметры разбиения отбрасываются.
• MODE_COPY_FROM_METADATA - Изображение будет соответствовать объекту метаданных, переданному в метод записи. setTiling выбросит IllegalStateException.

public int getTilingMode()

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

public Dimension[] getPreferredTileSizes()

Возвращает массив Dimension, указывающий допустимые диапазоны размеров плиток при кодировании в выходной файл или поток. Возвращаемый массив является копией.

Информация возвращается в виде пар; первый элемент пары содержит минимальную ширину и высоту (включительно), а второй элемент содержит максимальную ширину и высоту (включительно). Вместе каждая пара определяет допустимый диапазон размеров. Чтобы указать фиксированный размер, используйте одинаковые значения ширины и высоты для обоих элементов. Для указания произвольного диапазона используется значение null вместо фактического массива Dimension.

Если на этапе конструирования массив не указан, но разбиение на плитки разрешено, этот метод возвращает null.

public void setTiling(int tileWidth, int tileHeight, int tileGridXOffset, int tileGridYOffset)

Указывает, что изображение должно быть вымощено в выходном потоке. Параметры tileWidth и tileHeight задают ширину и высоту плиток в файле. Если ширина или высота плитки больше ширины или высоты изображения, то изображение не выкладывается в этом измерении.

Если canOffsetTiles возвращает false, то параметры tileGridXOffset и tileGridYOffset должны быть равны нулю.

public void unsetTiling()

Удаляет любые предыдущие параметры сетки плиток, заданные вызовами setTiling.

Реализация по умолчанию устанавливает переменные экземпляра tileWidth, tileHeight, tileGridXOffset и tileGridYOffset в значение 0.

public int getTileWidth()

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

public int getTileHeight()

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

public int getTileGridXOffset()

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

public int getTileGridYOffset()

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

public boolean canWriteProgressive()

Возвращает true, если писатель может записать изображения как серию проходов с возрастающим качеством.

public void setProgressiveMode(int mode)

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

Аргумент режима определяет, как выбираются параметры прогрессии, и должен быть либо MODE_DISABLED, либо MODE_COPY_FROM_METADATA, либо MODE_DEFAULT. В противном случае выброшено исключение IllegalArgumentException.

Режимы интерпретируются следующим образом:

• MODE_DISABLED - Нет прогрессии. Используйте это, чтобы отключить прогрессию.
• MODE_COPY_FROM_METADATA - Выходное изображение будет использовать параметры прогрессии, которые найдены в объектах метаданных, переданных в писатель.
• MODE_DEFAULT - Изображение будет записываться прогрессивно, с параметрами, выбранными писателем.

По умолчанию MODE_COPY_FROM_METADATA.

public int getProgressiveMode()

Возвращает текущий режим записи потока в прогрессивном режиме.

public boolean canWriteCompressed()

Возвращает true, если этот писатель поддерживает сжатие.

public void setCompressionMode(int mode)

Указывает, должно ли выполняться сжатие, и если да, то как определяются параметры сжатия. Аргумент mode должен быть одним из четырёх режимов, интерпретируемых следующим образом:

• MODE_DISABLED - Если режим установлен в MODE_DISABLED, методы, которые запрашивают или изменяют тип или параметры сжатия, выбросят исключение IllegalStateException (если сжатие обычно поддерживается плагином). Некоторые писатели, такие как JPEG, обычно не предлагают несжатый вывод. В этом случае попытка установить режим в MODE_DISABLED вызовет исключение UnsupportedOperationException, и режим не изменится.
• MODE_EXPLICIT - Сжать с использованием типа сжатия и настроек качества, указанных в этом ImageWriteParam. Любые ранее установленные параметры сжатия отбрасываются.
• MODE_COPY_FROM_METADATA - Используйте параметры сжатия, указанные в объектах метаданных, переданных в писатель.
• MODE_DEFAULT - Используйте параметры сжатия по умолчанию.

По умолчанию MODE_COPY_FROM_METADATA.

public int getCompressionMode()

Возвращает текущий режим сжатия, если сжатие поддерживается.

public String[] getCompressionTypes()

Возвращает список доступных типов сжатия в виде массива или String, или null, если тип сжатия не может быть выбран с помощью этих интерфейсов. Возвращаемый массив является копией.

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

Реализация по умолчанию проверяет, поддерживается ли сжатие, и бросает исключение UnsupportedOperationException, если нет. В противном случае она возвращает клонированный compressionTypes экземпляр переменной состояния, если он не null, или же возвращает null.

public void setCompressionType(String compressionType)

Устанавливает тип сжатия на одно из значений, указанных в getCompressionTypes. Если передано значение null, все предыдущие настройки удаляются.

Реализация по умолчанию проверяет, поддерживается ли сжатие и установлен ли режим сжатия MODE_EXPLICIT. Если да, то она вызывает getCompressionTypes и проверяет, является ли compressionType одним из допустимых значений. Если это так, то переменная состояния compressionType устанавливается. Если compressionType равно null, переменная состояния устанавливается без выполнения каких-либо проверок.

public String getCompressionType()

Возвращает текущий тип сжатия или null, если он не задан. Тип возвращается как String из тех, которые возвращаются getCompressionTypes. Если тип сжатия не установлен, возвращается null.

Реализация по умолчанию проверяет, поддерживается ли сжатие и установлен ли режим сжатия MODE_EXPLICIT. Если да, то возвращается значение переменной состояния compressionType.

public void unsetCompression()

Удаляет любые предыдущие настройки типа и качества сжатия.

Реализация по умолчанию устанавливает переменную состояния compressionType в значение null, и переменную состояния compressionQuality в значение 1.0F.

public String getLocalizedCompressionTypeName()

Возвращает локализованную версию имени текущего типа сжатия, используя Locale, возвращаемый getLocale.

Реализация по умолчанию проверяет, поддерживается ли сжатие и установлен ли режим сжатия MODE_EXPLICIT. Если compressionType равно non-null, значение getCompressionType возвращается для удобства.

public boolean isCompressionLossless()

Возвращает true, если текущий тип сжатия обеспечивает без потерь. Если модуль предоставляет только один обязательный тип сжатия, то этот метод может быть вызван без предварительного вызова setCompressionType.

Если есть несколько типов сжатия, но ни один не установлен, будет брошено исключение IllegalStateException.

Реализация по умолчанию проверяет, поддерживается ли сжатие и установлен ли режим сжатия MODE_EXPLICIT. Если да, то если getCompressionTypes() равно null или getCompressionType() не равно null, true возвращается для удобства.

public void setCompressionQuality(float quality)

Устанавливает качество сжатия в диапазоне от 0 до 1. По умолчанию поддерживается только одна настройка качества сжатия; записи могут предоставлять расширенные версии ImageWriteParam, которые предлагают больший контроль. Для схем сжатия с потерями качество сжатия должно управлять балансом между размером файла и качеством изображения (например, выбирая таблицы квантования при записи изображений JPEG). Для схем без потерь качество сжатия может использоваться для управления балансом между размером файла и временем, затрачиваемым на сжатие (например, оптимизируя фильтры строк и устанавливая уровень сжатия ZLIB при записи изображений PNG).

Настройка качества сжатия 0.0 в самых общих случаях интерпретируется как "важен высокий уровень сжатия", а настройка 1.0 — как "важно высокое качество изображения".

Если есть несколько типов сжатия, но ни один не установлен, будет брошено исключение IllegalStateException.

Реализация по умолчанию проверяет, поддерживается ли сжатие и установлен ли режим сжатия MODE_EXPLICIT. Если да, то если getCompressionTypes() возвращает null или compressionType не равно null, она устанавливает переменную состояния compressionQuality.

public float getCompressionQuality()

Возвращает текущую настройку качества сжатия.

Если есть несколько типов сжатия, но ни один не установлен, будет брошено исключение IllegalStateException.

Реализация по умолчанию проверяет, поддерживается ли сжатие и установлен ли режим сжатия MODE_EXPLICIT. Если да, то если getCompressionTypes() равно null или getCompressionType() не равно null, она возвращает значение переменной состояния compressionQuality.

public float getBitRate(float quality)

Возвращает float, указывающую на оценку количества битов выходных данных на каждый бит входных данных изображения при заданном уровне качества. Значение обычно лежит между 0 и 1, причём меньшие значения указывают на большую степень сжатия. Специальное значение -1.0F используется для указания отсутствия оценки.

Если есть несколько типов сжатия, но ни один не задан, выбрасывается IllegalStateException.

Реализация по умолчанию проверяет, поддерживается ли сжатие, и соответствует ли режим сжатия MODE_EXPLICIT. Если это так, если getCompressionTypes() равно null или getCompressionType() не является null, и quality находится в допустимых пределах, возвращается -1.0.

public String[] getCompressionQualityDescriptions()

Возвращает массив String, которые могут использоваться вместе с getCompressionQualityValues в пользовательском интерфейсе для настройки или отображения уровня качества сжатия. String с индексом i предоставляет описание диапазона уровней качества между getCompressionQualityValues[i] и getCompressionQualityValues[i + 1]. Обратите внимание, что длина массива, возвращаемого getCompressionQualityValues, всегда на единицу больше, чем возвращаемая getCompressionQualityDescriptions.

Например, строки "Хорошо", "Лучше" и "Отлично" могут быть связаны с диапазонами [0, .33), [.33, .66) и [.66, 1.0]. В этом случае getCompressionQualityDescriptions вернёт { "Good", "Better", "Best" }, а getCompressionQualityValues вернёт { 0.0F, .33F, .66F, 1.0F }.

Если описания недоступны, возвращается null. Если из getCompressionQualityValues возвращается null, этот метод также должен вернуть null.

Описания должны быть локализованы для Locale, возвращаемого getLocale, если оно не равно null.

Если есть несколько типов сжатия, но ни один не задан, выбрасывается IllegalStateException.

Реализация по умолчанию проверяет, поддерживается ли сжатие, и соответствует ли режим сжатия MODE_EXPLICIT. Если это так, если getCompressionTypes() равно null или getCompressionType() не равно null, возвращается null.

public float[] getCompressionQualityValues()

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

Если описания недоступны, возвращается null. Если из getCompressionQualityDescriptions возвращается null, этот метод также должен вернуть null.

Если есть несколько типов сжатия, но ни один не задан, выбрасывается IllegalStateException.

Реализация по умолчанию проверяет, поддерживается ли сжатие, и соответствует ли режим сжатия MODE_EXPLICIT. Если это так, если getCompressionTypes() равно null или getCompressionType() не равно null, возвращается null.