Класс ImageIO

public final class ImageIO
extends Object

Методы

scanForPlugins

public static void scanForPlugins()

См. также:

ClassLoader.getResources(java.lang.String)

setUseCache

public static void setUseCache(boolean useCache)

Параметры:

useCache - a boolean, указывающий, следует ли использовать файл кэша в тех случаях, когда это необязательно.

См. также:

getUseCache()

getUseCache

public static boolean getUseCache()

Возвращает текущее значение, установленное setUseCache, или true, если явное значение не было задано.

Возвращает:

true, если для ImageInputStream и ImageOutputStream можно использовать кэш на диске.

См. также:

setUseCache(boolean)

setCacheDirectory

public static void setCacheDirectory(File cacheDirectory)

Устанавливает каталог, в котором будут создаваться файлы кэша. Значение null указывает на использование зависящего от системы каталога временных файлов по умолчанию. Если getUseCache возвращает false, это значение игнорируется.

Параметры:

cacheDirectory - a File, определяющий каталог.

Исключения:

SecurityException - если менеджер безопасности запрещает доступ к каталогу.

IllegalArgumentException - если cacheDir не пустое, но не является каталогом.

См. также:

File.createTempFile(String, String, File), getCacheDirectory()

getCacheDirectory

public static File getCacheDirectory()

Возвращает текущее значение, установленное setCacheDirectory, или null если явное значение не было задано.

Возвращает:

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

См. также:

setCacheDirectory(java.io.File)

createImageInputStream

public static ImageInputStream createImageInputStream(Object input)
                                               throws IOException

Параметры:

input - объект Object, используемый в качестве источника ввода, например, File, читаемый RandomAccessFile или InputStream.

Возвращает:

объект ImageInputStream, или null.

Исключения:

IllegalArgumentException - если input является null.

IOException - если требуется файл кэша, но он не может быть создан.

См. также:

ImageInputStreamSpi

createImageOutputStream

public static ImageOutputStream createImageOutputStream(Object output)
                                                 throws IOException

Параметры:

output - объект Object, используемый в качестве пункта назначения вывода, например, File, записываемый RandomAccessFile или OutputStream.

Возвращает:

объект ImageOutputStream, или null.

Исключения:

IllegalArgumentException - если output является null.

IOException - если требуется файл кэша, но он не может быть создан.

См. также:

ImageOutputStreamSpi

getReaderFormatNames

public static String[] getReaderFormatNames()

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

Возвращает:

массив String.

getReaderMIMETypes

public static String[] getReaderMIMETypes()

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

Возвращает:

массив String.

getReaderFileSuffixes

public static String[] getReaderFileSuffixes()

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

Возвращает:

массив String.

С тех пор:

1.6

getImageReaders

public static Iterator<ImageReader> getImageReaders(Object input)

Параметры:

input - ImageInputStream или другой Object, содержащий закодированные данные изображения.

Возвращает:

объект Iterator содержащий ImageReader.

Исключения:

IllegalArgumentException - если input является null.

См. также:

ImageReaderSpi.canDecodeInput(java.lang.Object)

getImageReadersByFormatName

public static Iterator<ImageReader> getImageReadersByFormatName(String formatName)

Возвращает Iterator содержащий все текущие зарегистрированные ImageReaders, которые заявляют о возможности декодирования указанного формата.

Параметры:

formatName - a String содержащий неформальное имя формата (например, "jpeg" или "tiff").

Возвращает:

объект Iterator содержащий ImageReader.

Исключения:

IllegalArgumentException - если formatName является null.

См. также:

ImageReaderWriterSpi.getFormatNames()

getImageReadersBySuffix

public static Iterator<ImageReader> getImageReadersBySuffix(String fileSuffix)

Возвращает Iterator содержащий все текущие зарегистрированные ImageReaders, которые заявляют о возможности декодирования файлов с указанным расширением.

Параметры:

fileSuffix - a String содержащий расширение файла (например, "jpg" или "tiff").

Возвращает:

объект Iterator содержащий ImageReader.

Исключения:

IllegalArgumentException - если fileSuffix является null.

См. также:

ImageReaderWriterSpi.getFileSuffixes()

getImageReadersByMIMEType

public static Iterator<ImageReader> getImageReadersByMIMEType(String MIMEType)

Возвращает Iterator содержащий все текущие зарегистрированные ImageReaders, которые заявляют о возможности декодирования файлов с указанным MIME-типом.

Параметры:

MIMEType - a String содержащий расширение файла (например, "image/jpeg" или "image/x-bmp").

Возвращает:

объект Iterator содержащий ImageReader.

Исключения:

IllegalArgumentException - если MIMEType является null.

См. также:

ImageReaderWriterSpi.getMIMETypes()

getWriterFormatNames

public static String[] getWriterFormatNames()

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

Возвращает:

массив String.

getWriterMIMETypes

public static String[] getWriterMIMETypes()

Возвращает массив String со списком всех MIME-типов, поддерживаемых текущим набором зарегистрированных записывателей.

Возвращает:

массив String.

getWriterFileSuffixes

public static String[] getWriterFileSuffixes()

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

Возвращает:

массив String.

С:

1.6

getImageWritersByFormatName

public static Iterator<ImageWriter> getImageWritersByFormatName(String formatName)

Возвращает Iterator, содержащий все текущие зарегистрированные ImageWriter , которые утверждают, что могут кодировать указанный формат.

Параметры:

formatName - String, содержащий неофициальное имя формата (например, "jpeg" или "tiff").

Возвращает:

Iterator , содержащий ImageWriter.

Выбрасывает:

IllegalArgumentException - если formatName является null.

См. также:

ImageReaderWriterSpi.getFormatNames()

getImageWritersBySuffix

public static Iterator<ImageWriter> getImageWritersBySuffix(String fileSuffix)

Возвращает Iterator , содержащий все текущие зарегистрированные ImageWriter , которые утверждают, что могут кодировать файлы с заданным расширением.

Параметры:

fileSuffix - String, содержащий расширение файла (например, "jpg" или "tiff").

Возвращает:

Iterator , содержащий ImageWriter.

Выбрасывает:

IllegalArgumentException - если fileSuffix является null.

См. также:

ImageReaderWriterSpi.getFileSuffixes()

getImageWritersByMIMEType

public static Iterator<ImageWriter> getImageWritersByMIMEType(String MIMEType)

Возвращает Iterator , содержащий все текущие зарегистрированные ImageWriter , которые утверждают, что могут кодировать файлы с заданным MIME-типом.

Параметры:

MIMEType - String, содержащий расширение файла (например, "image/jpeg" или "image/x-bmp").

Возвращает:

Iterator , содержащий ImageWriter.

Выбрасывает:

IllegalArgumentException - если MIMEType является null.

См. также:

ImageReaderWriterSpi.getMIMETypes()

getImageWriter

public static ImageWriter getImageWriter(ImageReader reader)

Возвращает ImageWriter, соответствующий заданному ImageReader, если он существует, или null, если плагин для данного ImageReader не указывает соответствующего ImageWriter, или если заданный ImageReader не зарегистрирован. Этот механизм может использоваться для получения ImageWriter, который будет понимать внутреннюю структуру метаданных, не относящихся к пикселям (кодированных объектами IIOMetadata), созданных ImageReader. Получая эти данные из ImageReader и передавая их в ImageWriter, полученный этим методом, клиентская программа может читать изображение, изменить его каким-либо образом и записать его обратно, сохранив все метаданные, не понимая ничего о структуре метаданных или даже о формате изображения. Обратите внимание, что этот метод возвращает «предпочтительного» записывателя, который является первым в списке, возвращаемом javax.imageio.spi.ImageReaderSpi.getImageWriterSpiNames().

Параметры:

reader - экземпляр зарегистрированного ImageReader.

Возвращает:

ImageWriter, или null.

Выбрасывает:

IllegalArgumentException - если reader является null.

См. также:

getImageReader(ImageWriter), ImageReaderSpi.getImageWriterSpiNames()

getImageReader

public static ImageReader getImageReader(ImageWriter writer)

Возвращает ImageReader, соответствующий заданному ImageWriter, если он существует, или null, если плагин для данного ImageWriter не указывает соответствующего ImageReader, или если заданный ImageWriter не зарегистрирован. Этот метод предоставляется в основном для симметрии с getImageWriter(ImageReader). Обратите внимание, что этот метод возвращает «предпочтительного» читателя, который является первым в списке, возвращаемом javax.imageio.spi.ImageWriterSpi.getImageReaderSpiNames().

Параметры:

writer - экземпляр зарегистрированного ImageWriter.

Возвращает:

ImageReader, или null.

Выбрасывает:

IllegalArgumentException - если writer является null.

См. также:

getImageWriter(ImageReader), ImageWriterSpi.getImageReaderSpiNames()

getImageWriters

public static Iterator<ImageWriter> getImageWriters(ImageTypeSpecifier type,
                                                    String formatName)

Возвращает Iterator , содержащий все текущие зарегистрированные ImageWriter , которые утверждают, что могут кодировать изображения заданной структуры (указанной с помощью ImageTypeSpecifier) в заданном формате.

Параметры:

type - ImageTypeSpecifier , указывающий структуру изображения, которое должно быть записано.

formatName - неофициальное имя format.

Возвращает:

Iterator , содержащий ImageWriter.

Выбрасывает:

IllegalArgumentException - если любой параметр является null.

См. также:

ImageWriterSpi.canEncodeImage(ImageTypeSpecifier)

getImageTranscoders

public static Iterator<ImageTranscoder> getImageTranscoders(ImageReader reader,
                                                            ImageWriter writer)

Возвращает Iterator , содержащий все текущие зарегистрированные ImageTranscoder , которые утверждают, что могут преобразовывать метаданные заданного ImageReader и ImageWriter.

Параметры:

reader - ImageReader.

writer - ImageWriter.

Возвращает:

Iterator , содержащий ImageTranscoder.

Выбрасывает:

IllegalArgumentException - если reader или writer является null.

read

public static BufferedImage read(File input)
                          throws IOException

Параметры:

input - File для чтения.

Возвращает:

BufferedImage, содержащий декодированное содержимое входных данных, или null.

Выбрасывает:

IllegalArgumentException - если input является null.

IOException - если при чтении произошла ошибка или при создании необходимого ImageInputStream.

read

public static BufferedImage read(InputStream input)
                          throws IOException

Параметры:

input - InputStream для чтения.

Возвращает:

BufferedImage, содержащий декодированное содержимое входных данных, или null.

Выбрасывает:

IllegalArgumentException - если input является null.

IOException - если при чтении произошла ошибка или при создании необходимого ImageInputStream.

read

public static BufferedImage read(URL input)
                          throws IOException

Параметры:

input - объект URL для чтения.

Возвращает:

объект BufferedImage, содержащий декодированное содержимое входных данных, или null.

Выбрасывает:

IllegalArgumentException - если input является null.

IOException - если произошла ошибка во время чтения или при создании необходимого объекта ImageInputStream.

read

public static BufferedImage read(ImageInputStream stream)
                          throws IOException

Параметры:

stream - объект ImageInputStream для чтения.

Возвращает:

объект BufferedImage, содержащий декодированное содержимое входных данных, или null.

Выбрасывает:

IllegalArgumentException - если stream является null.

IOException - если произошла ошибка во время чтения.

write

public static boolean write(RenderedImage im,
                            String formatName,
                            ImageOutputStream output)
                     throws IOException

Параметры:

im - изображение RenderedImage для записи.

formatName - строка String содержащая неофициальное имя формата.

output - объект ImageOutputStream для записи.

Возвращает:

false если подходящий записыватель не найден.

Выбрасывает:

IllegalArgumentException - если какой-либо параметр является null.

IOException - если произошла ошибка во время записи.

write

public static boolean write(RenderedImage im,
                            String formatName,
                            File output)
                     throws IOException

Записывает изображение, используя произвольный ImageWriter поддерживающий заданный формат, в файл File. Если файл уже существует, его содержимое отбрасывается.

Параметры:

im - изображение RenderedImage для записи.

formatName - строка String содержащая неофициальное имя формата.

output - файл File для записи.

Возвращает:

false если подходящий записыватель не найден.

Выбрасывает:

IllegalArgumentException - если какой-либо параметр является null.

IOException - если произошла ошибка во время записи или при создании необходимого объекта ImageOutputStream.

write

public static boolean write(RenderedImage im,
                            String formatName,
                            OutputStream output)
                     throws IOException

Параметры:

im - изображение RenderedImage для записи.

formatName - строка String содержащая неофициальное имя формата.

output - поток OutputStream для записи.

Возвращает:

false если подходящий записыватель не найден.

Выбрасывает:

IllegalArgumentException - если какой-либо параметр является null.

IOException - если произошла ошибка во время записи или при создании необходимого объекта ImageOutputStream.