模块  java.desktop
软件包  javax.imageio.spi

Class ImageReaderWriterSpi

    • 字段详细信息

      • names

        protected String[] names
        从getFormatNames返回的字符串数组，最初为null 。 构造函数应将其设置为非值null 。

      • suffixes

        protected String[] suffixes
        从 getFileSuffixes返回的字符串数组，最初为 null 。

      • MIMETypes

        protected String[] MIMETypes
        要从 getMIMETypes返回的字符串数组，最初为 null 。

      • pluginClassName

        protected String pluginClassName
        甲 String包含相关插件类的名称，最初 null 。

      • supportsStandardStreamMetadataFormat

        protected boolean supportsStandardStreamMetadataFormat
        一个布尔值，指示此插件是否支持流元数据的标准元数据格式，最初为 false 。

      • nativeStreamMetadataFormatName

        protected String nativeStreamMetadataFormatName
        甲 String包含此插件，最初支持的本地流元数据格式的名称 null 。

      • nativeStreamMetadataFormatClassName

        protected String nativeStreamMetadataFormatClassName
        甲 String包含此插件，最初支持的本地流元数据格式的类名称 null 。

      • extraStreamMetadataFormatNames

        protected String[] extraStreamMetadataFormatNames
        一个 String的数组，包含此插件支持的任何其他流元数据格式的名称，最初为 null 。

      • extraStreamMetadataFormatClassNames

        protected String[] extraStreamMetadataFormatClassNames
        一个 String的数组，包含此插件支持的任何其他流元数据格式的类名，最初为 null 。

      • supportsStandardImageMetadataFormat

        protected boolean supportsStandardImageMetadataFormat
        一个布尔值，指示此插件是否支持图像元数据的标准元数据格式，最初为 false 。

      • nativeImageMetadataFormatName

        protected String nativeImageMetadataFormatName
        甲 String包含此插件，最初支持的本地流元数据格式的名称 null 。

      • nativeImageMetadataFormatClassName

        protected String nativeImageMetadataFormatClassName
        甲 String包含此插件，最初支持的本地流元数据格式的类名称 null 。

      • extraImageMetadataFormatNames

        protected String[] extraImageMetadataFormatNames
        一个 String的数组，包含此插件支持的任何其他图像元数据格式的名称，最初为 null 。

      • extraImageMetadataFormatClassNames

        protected String[] extraImageMetadataFormatClassNames
        一个 String的数组，包含此插件支持的任何其他图像元数据格式的类名，最初为 null 。

    • 构造方法详细信息

      • ImageReaderWriterSpi

        public ImageReaderWriterSpi​(String vendorName,
                            String version,
                            String[] names,
                            String[] suffixes,
                            String[] MIMETypes,
                            String pluginClassName,
                            boolean supportsStandardStreamMetadataFormat,
                            String nativeStreamMetadataFormatName,
                            String nativeStreamMetadataFormatClassName,
                            String[] extraStreamMetadataFormatNames,
                            String[] extraStreamMetadataFormatClassNames,
                            boolean supportsStandardImageMetadataFormat,
                            String nativeImageMetadataFormatName,
                            String nativeImageMetadataFormatClassName,
                            String[] extraImageMetadataFormatNames,
                            String[] extraImageMetadataFormatClassNames)
        构造具有给定值集的 ImageReaderWriterSpi 。
        参数
        vendorName - 供应商名称，作为非 null String 。
        version - 版本标识符，非 null String 。
        names - 非null数组， String指示格式名称的String 。 必须至少有一个条目。
        suffixes -的阵列String指示常用文件后缀。 如果未定义后缀，则应提供null 。 长度为0的数组将标准化为null 。
        MIMETypes - 指示格式的MIME类型的String数组。 如果未定义MIME类型，则应提供null 。 长度为0的数组将标准化为null 。
        pluginClassName - 关联的 ImageReader或 ImageWriter类的完全限定名称，作为非 null String 。
        supportsStandardStreamMetadataFormat - boolean ，指示流元数据对象是否可以使用标准元数据格式描述的树。
        nativeStreamMetadataFormatName -一个 String ，或 null ，从返回 getNativeStreamMetadataFormatName 。
        nativeStreamMetadataFormatClassName - String或 null ，用于实例化要从 getNativeStreamMetadataFormat返回的元数据格式对象。
        extraStreamMetadataFormatNames -的阵列String S或null从返回， getExtraStreamMetadataFormatNames 。 长度为0的数组规范化为null 。
        extraStreamMetadataFormatClassNames - 一个String s或null的数组，用于实例化要从getStreamMetadataFormat返回的元数据格式对象。 长度为0的数组规范化为null 。
        supportsStandardImageMetadataFormat - boolean ，指示图像元数据对象是否可以使用标准元数据格式描述的树。
        nativeImageMetadataFormatName -一个 String ，或 null ，从返回 getNativeImageMetadataFormatName 。
        nativeImageMetadataFormatClassName - String或 null ，用于实例化从 getNativeImageMetadataFormat返回的元数据格式对象。
        extraImageMetadataFormatNames -的阵列String从返回小号getExtraImageMetadataFormatNames 。 长度为0的数组规范化为null 。
        extraImageMetadataFormatClassNames - 一个String s或null的数组，用于实例化从getImageMetadataFormat返回的元数据格式对象。 长度为0的数组规范化为null 。
        异常
        IllegalArgumentException - 如果 vendorName是 null 。
        IllegalArgumentException - 如果 version是 null 。
        IllegalArgumentException - 如果 names是 null或者长度为0。
        IllegalArgumentException - 如果 pluginClassName是 null 。

      • ImageReaderWriterSpi

        public ImageReaderWriterSpi()
        构造一个空白ImageReaderWriterSpi 。 由子类来初始化实例变量和/或覆盖方法实现，以便提供所有方法的工作版本。

    • 方法详细信息

      • getFormatNames

        public String[] getFormatNames()
        返回String的数组， String包含通常可由与此服务提供程序关联的ImageReader或ImageWriter实现使用的格式的可读名称。 例如，单个ImageReader可能能够处理PBM和PNM文件。
        结果
        非 null数组 String或长度至少为1，包含与此阅读器或 String器关联的非正式格式名称。

      • getFileSuffixes

        public String[] getFileSuffixes()
        返回一个String的数组， String包含与通常与此服务提供者关联的ImageReader或ImageWriter实现可用的格式相关联的文件后缀列表。 例如，单个ImageReader可能能够处理带有'.pbm'和'.pnm'后缀，或者'.jpg'和'.jpeg'后缀的文件。 如果没有已知的文件后缀，则将返回null 。

        返回特定后缀并不能保证可以处理具有该后缀的文件; 它仅表示尝试使用此服务提供程序解码或编码此类文件可能是值得的。

        结果
        包含与此读取器或写入器关联的公共文件后缀的 String或长度至少为1的数组，或 null 。

      • getMIMETypes

        public String[] getMIMETypes()
        返回一个String的数组， String包含与通常可与此服务提供者关联的ImageReader或ImageWriter实现使用的格式关联的MIME类型列表。

        理想情况下，为了描述特定格式，只需要一种MIME类型。 但是，由于多种原因，有必要将类型列表与每个服务提供商相关联。 首先，许多常见的图像文件格式没有标准的MIME类型，因此需要使用常用的非官方名称列表，例如image/x-pbm和image/x-portable-bitmap 。 某些文件格式具有官方MIME类型，但有时可能会使用之前的非官方指定来引用，例如image/x-png而不是官方image/png 。 最后，单个服务提供者可能能够从MIME的角度解析多个不同类型，例如image/x-xbitmap和image/x-xpixmap 。

        返回特定的MIME类型并不能保证可以处理声称属于该类型的文件; 它仅表示尝试使用此服务提供程序解码或编码此类文件可能是值得的。

        结果
        包含与此读取器或写入程序关联的MIME类型的 String s或长度至少为1的数组，或 null 。

      • getPluginClassName

        public String getPluginClassName()
        返回与此服务提供者关联的 ImageReader或 ImageWriter插件的完全限定类名。
        结果
        类名称，非 null String 。

      • isStandardStreamMetadataFormatSupported

        public boolean isStandardStreamMetadataFormatSupported()
        如果标准元数据格式是由此插件生成或使用的流元数据对象上的 getAsTree和 setFromTree方法识别的文档格式之一，则返回 true 。
        结果
        true如果流元数据支持标准格式。

      • getNativeStreamMetadataFormatName

        public String getNativeStreamMetadataFormatName()
        返回此插件的“本机”流元数据格式的名称，该格式通常允许无损编码和传输以此插件处理的格式存储的流元数据。 如果不支持此类格式，则将返回null 。

        默认实现返回nativeStreamMetadataFormatName实例变量，该变量通常由构造函数设置。

        结果
        本地流元数据格式的名称，或 null 。

      • getExtraStreamMetadataFormatNames

        public String[] getExtraStreamMetadataFormatNames()
        返回String的数组， String包含由本插件生成或使用的流元数据对象上的getAsTree和setFromTree方法识别的除本机和标准格式之外的其他文档格式的名称。

        如果插件不处理元数据，则应返回null。

        格式集可以根据读取或写入的特定图像而不同; 此方法应指示插件在任何情况下支持的所有其他格式。

        默认实现返回extraStreamMetadataFormatNames实例变量的克隆，该变量通常由构造函数设置。

        结果
        一个 String s的数组，或null。
        另请参见：
        IIOMetadata.getMetadataFormatNames() ， getExtraImageMetadataFormatNames() ， getNativeStreamMetadataFormatName()

      • isStandardImageMetadataFormatSupported

        public boolean isStandardImageMetadataFormatSupported()
        如果标准元数据格式是由此插件生成或使用的图像元数据对象上的 getAsTree和 setFromTree方法识别的文档格式之一，则返回 true 。
        结果
        true如果图像元数据支持标准格式。

      • getNativeImageMetadataFormatName

        public String getNativeImageMetadataFormatName()
        返回此插件的“本机”图像元数据格式的名称，该格式通常允许无损编码和传输以此插件处理的格式存储的图像元数据。 如果不支持此类格式，则将返回null 。

        默认实现返回nativeImageMetadataFormatName实例变量，该变量通常由构造函数设置。

        结果
        本机映像元数据格式的名称，或 null 。
        另请参见：
        getExtraImageMetadataFormatNames()

      • getExtraImageMetadataFormatNames

        public String[] getExtraImageMetadataFormatNames()
        返回String的数组， String包含getAsTree和setFromTree方法在此插件生成或使用的图像元数据对象上识别的其他文档格式的名称（本机格式和标准格式getAsTree 。

        如果插件不处理图像元数据，则应返回null。

        格式集可以根据读取或写入的特定图像而不同; 此方法应指示插件在任何情况下支持的所有其他格式。

        默认实现返回extraImageMetadataFormatNames实例变量的克隆，该变量通常由构造函数设置。

        结果
        一个 String的数组，或null。
        另请参见：
        IIOMetadata.getMetadataFormatNames() ， getExtraStreamMetadataFormatNames() ， getNativeImageMetadataFormatName()

      • getStreamMetadataFormat

        public IIOMetadataFormat getStreamMetadataFormat​(String formatName)
        返回一个IIOMetadataFormat对象描述给定的流元数据格式，或null如果没有可用的描述。 提供的名称必须是本机流元数据格式名称，标准元数据格式名称或getExtraStreamMetadataFormatNames返回的名称之一。
        参数
        formatName - 所需的流元数据格式。
        结果
        一个 IIOMetadataFormat对象。
        异常
        IllegalArgumentException - 如果 formatName是 null或者不是受支持的名称。

      • getImageMetadataFormat

        public IIOMetadataFormat getImageMetadataFormat​(String formatName)
        返回一个IIOMetadataFormat对象描述给定的图像的元数据格式，或null如果没有可用的描述。 提供的名称必须是本机映像元数据格式名称，标准元数据格式名称或getExtraImageMetadataFormatNames返回的名称之一。
        参数
        formatName - 所需的图像元数据格式。
        结果
        一个 IIOMetadataFormat对象。
        异常
        IllegalArgumentException - 如果 formatName是 null或者不是受支持的名称。