javax.imageio.spi

クラス ImageReaderWriterSpi

java.lang.Object

javax.imageio.spi.IIOServiceProvider

javax.imageio.spi.ImageReaderWriterSpi

すべての実装されたインタフェース:

RegisterableService

直系の既知のサブクラス:

ImageReaderSpi, ImageWriterSpi

public abstract class ImageReaderWriterSpi
extends IIOServiceProvider

ImageReaderSpi と ImageWriterSpi に共通のインスタンス変数およびメソッドを含むスーパークラスです。

関連項目:

IIORegistry, ImageReaderSpi, ImageWriterSpi

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected String[]	extraImageMetadataFormatClassNames このプラグインがサポートするすべての追加イメージメタデータ形式のクラス名を含む String 配列で、最初は null です。
protected String[]	extraImageMetadataFormatNames このプラグインがサポートするすべての追加イメージメタデータ形式の名前を含む String 配列で、最初は null です。
protected String[]	extraStreamMetadataFormatClassNames このプラグインがサポートするすべての追加ストリームメタデータ形式のクラス名を含む String 配列で、最初は null です。
protected String[]	extraStreamMetadataFormatNames このプラグインがサポートするすべての追加ストリームメタデータ形式の名前を含む String 配列で、最初は null です。
protected String[]	MIMETypes getMIMETypes から返される文字列の配列で、最初は null です。
protected String[]	names getFormatNames から返される文字列の配列で、最初は null です。
protected String	nativeImageMetadataFormatClassName このプラグインでサポートされるネイティブのストリームメタデータ形式のクラス名を含む String で、最初は null です。
protected String	nativeImageMetadataFormatName このプラグインでサポートされるネイティブのストリームメタデータ形式の名前を含む String で、最初は null です。
protected String	nativeStreamMetadataFormatClassName このプラグインでサポートされるネイティブのストリームメタデータ形式のクラス名を含む String で、最初は null です。
protected String	nativeStreamMetadataFormatName このプラグインでサポートされるネイティブのストリームメタデータ形式の名前を含む String で、最初は null です。
protected String	pluginClassName 関連するプラグインクラスの名前を含む String で、最初は null です。
protected String[]	suffixes getFileSuffixes から返される文字列の配列で、最初は null です。
protected boolean	supportsStandardImageMetadataFormat このプラグインがイメージメタデータに標準のメタデータ形式をサポートするかどうかを示す boolean で、最初は false です。
protected boolean	supportsStandardStreamMetadataFormat このプラグインがストリームメタデータに標準のメタデータ形式をサポートするかどうかを示す boolean で、最初は false です。

クラス javax.imageio.spi.IIOServiceProvider から継承されたフィールド

vendorName, version

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ImageReaderWriterSpi() 空白の ImageReaderWriterSpi を構築します。
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 を構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String[]	getExtraImageMetadataFormatNames() このプラグインが作成または使用するイメージメタデータオブジェクトで、getAsTree および setFromTree メソッドが認識する、ネイティブおよび標準形式以外の追加ドキュメント形式の名前を含む String 配列を返します。
String[]	getExtraStreamMetadataFormatNames() このプラグインが作成または使用するストリームメタデータオブジェクトで、getAsTree および setFromTree メソッドが認識する、ネイティブおよび標準形式以外の追加ドキュメント形式の名前を含む String 配列を返します。
String[]	getFileSuffixes() このサービスプロバイダに関連する ImageReader または ImageWriter 実装で一般的に使用可能な形式に関連付けられたファイル接尾辞のリストを含む String 配列を返します。
String[]	getFormatNames() このサービスプロバイダに関連する ImageReader または ImageWriter 実装で一般的に使用できる形式の判読可能な名前を含む String 配列を返します。
IIOMetadataFormat	getImageMetadataFormat(String formatName) 指定されたイメージメタデータ形式を説明する IIOMetadataFormat オブジェクト、または説明がない場合は null を返します。
String[]	getMIMETypes() このサービスプロバイダに関連する ImageReader または ImageWriter 実装で一般的に使用可能な形式に関連付けられた MIME タイプのリストを含む String 配列を返します。
String	getNativeImageMetadataFormatName() このプラグインの「ネイティブ」イメージメタデータ形式の名前を返します。通常、この形式を使用すると、このプラグインが処理する形式で格納されているイメージメタデータを劣化せず、にエンコードおよび転送できます。
String	getNativeStreamMetadataFormatName() このプラグインの「ネイティブ」ストリームメタデータ形式の名前を返します。通常、この形式を使用すると、このプラグインが処理する形式で格納されているストリームメタデータを劣化せずに、エンコードおよび転送できます。
String	getPluginClassName() このサービスプロバイダに関連する ImageReader または ImageWriter プラグインの完全修飾クラス名を返します。
IIOMetadataFormat	getStreamMetadataFormat(String formatName) 指定されたストリームメタデータ形式を説明する IIOMetadataFormat オブジェクト、または説明がない場合は null を返します。
boolean	isStandardImageMetadataFormatSupported() このプラグインが作成または使用するイメージメタデータオブジェクトで、getAsTree および setFromTree メソッドが認識するドキュメント形式に標準のメタデータ形式が含まれる場合は、true を返します。
boolean	isStandardStreamMetadataFormatSupported() このプラグインが作成または使用するストリームメタデータオブジェクトで getAsTree および setFromTree メソッドが認識するドキュメント形式に標準のメタデータ形式が含まれる場合は、true を返します。

クラス javax.imageio.spi.IIOServiceProvider から継承されたメソッド

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

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

このプラグインがストリームメタデータに標準のメタデータ形式をサポートするかどうかを示す boolean で、最初は 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

このプラグインがイメージメタデータに標準のメタデータ形式をサポートするかどうかを示す boolean で、最初は 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 配列。1 つ以上のエントリが存在する必要がある。

suffixes - 共通のファイル接尾辞を示す String 配列。接尾辞が定義されていない場合は、null を指定する。長さ 0 の配列は null に正規化される。

MIMETypes - 形式の MIME タイプを示す String 配列。MIME タイプが定義されていない場合は、null を指定する。長さ 0 の配列は null に正規化される。

pluginClassName - 関連付けられた ImageReader または ImageWriter クラスの完全修飾名 (null 以外の String)。

supportsStandardStreamMetadataFormat - ストリームメタデータオブジェクトが標準メタデータ形式で記述されたツリーを使用可能かどうかを示す boolean。

nativeStreamMetadataFormatName - getNativeStreamMetadataFormatName から返される String、または null。

nativeStreamMetadataFormatClassName - getNativeStreamMetadataFormat から返されるメタデータ形式オブジェクトのインスタンス化で使用する String、または null。

extraStreamMetadataFormatNames - getExtraStreamMetadataFormatNames から返される String の配列、または null。長さ 0 の配列は null に正規化される。

extraStreamMetadataFormatClassNames - getStreamMetadataFormat から返されるメタデータ形式オブジェクトのインスタンス化で使用する String の配列、または null。長さ 0 の配列は null に正規化される。

supportsStandardImageMetadataFormat - イメージメタデータオブジェクトが、標準のメタデータ形式で記述されたツリーを使用できるかどうかを示す boolean。

nativeImageMetadataFormatName - getNativeImageMetadataFormatName から返される String、または null。

nativeImageMetadataFormatClassName - getNativeImageMetadataFormat から返されるメタデータ形式オブジェクトのインスタンス化で使用する String、または null。

extraImageMetadataFormatNames - getExtraImageMetadataFormatNames から返される String の配列。長さ 0 の配列は null に正規化される。

extraImageMetadataFormatClassNames - getImageMetadataFormat から返されるメタデータ形式オブジェクトのインスタンス化で使用する String の配列、または null。長さ 0 の配列は null に正規化される。

例外:

IllegalArgumentException - vendorName が null の場合。

IllegalArgumentException - version が null の場合。

IllegalArgumentException - names が null または長さ 0 の場合。

IllegalArgumentException - pluginClassName が null の場合。

ImageReaderWriterSpi

public ImageReaderWriterSpi()

空白の ImageReaderWriterSpi を構築します。すべてのメソッドの作業バージョンを提供するための、インスタンス変数の初期化やメソッド実装のオーバーライドは、サブクラスで行う必要があります。

メソッドの詳細

getFormatNames

public String[] getFormatNames()

このサービスプロバイダに関連する ImageReader または ImageWriter 実装で一般的に使用できる形式の判読可能な名前を含む String 配列を返します。たとえば、1 つの ImageReader で PBM ファイルと PNM ファイルの両方を処理できる場合があります。

戻り値:

このリーダーまたはライターに関連する非公式の形式名を含む、長さ 1 以上の String 配列 (null 以外)。

getFileSuffixes

public String[] getFileSuffixes()

このサービスプロバイダに関連する ImageReader または ImageWriter 実装で一般的に使用可能な形式に関連付けられたファイル接尾辞のリストを含む String 配列を返します。たとえば、1 つの ImageReader で .pbm や .pnm、または .jpg や .jpeg の接尾辞を持つファイルを処理することができる場合があります。既知のファイル接尾辞が存在しない場合は、null を返します。

特定の接尾辞が返されても、その接尾辞を持つファイルの処理は保証されません。このサービスプロバイダを使用して、この種のファイルのエンコードまたはデコードを試みる価値があることを示しているにすぎません。

戻り値:

このリーダーまたはライターに関連する共通のファイル接尾辞を含む、長さ 1 以上の String 配列、または null。

getMIMETypes

public String[] getMIMETypes()

このサービスプロバイダに関連する ImageReader または ImageWriter 実装で一般的に使用可能な形式に関連付けられた MIME タイプのリストを含む String 配列を返します。

特定の形式を記述するのに必要な MIME タイプは 1 つだけであるのが理想的です。しかし、いくつかの理由から、各サービスプロバイダに複数のタイプを関連付ける必要があります。第一に、多くの共通イメージファイル形式には標準の MIME タイプがないので、image/x-pbm や image/x-portable-bitmap などの共通に使用される非公式の名前リストが必要です。一部のファイル形式には正式の MIME タイプがありますが、正式の image/png ではなく、image/x-png のような以前の非公式な指定を利用して参照されるものがあります。最後に、1 つのサービスプロバイダが、MIME の観点から複数の別個の形式 (image/x-xbitmap や image/x-xpixmap など) を解析できる場合があります。

特定の MIME タイプが返されても、そのタイプのファイルの処理が保証されるわけではありません。このサービスプロバイダを使用して、この種のファイルのエンコードまたはデコードを試みる価値があることを示しているにすぎません。

戻り値:

このリーダーまたはライターに関連する MIME タイプを含む、長さ 1 以上の String 配列、または 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()

このプラグインが作成または使用するストリームメタデータオブジェクトで、getAsTree および setFromTree メソッドが認識する、ネイティブおよび標準形式以外の追加ドキュメント形式の名前を含む String 配列を返します。

プラグインがメタデータを処理しない場合は、null を返します。

形式セットは、読み込みまたは書き込みの行われるイメージにより異なる場合があります。このメソッドは、どの状況でも、プラグインがサポートする追加形式をすべて示す必要があります。

デフォルトの実装では、通常はコンストラクタで設定される extraStreamMetadataFormatNames インスタンス変数の複製を返します。

戻り値:

String の配列、または 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()

このプラグインが作成または使用するイメージメタデータオブジェクトで、getAsTree および setFromTree メソッドが認識する、ネイティブおよび標準形式以外の追加ドキュメント形式の名前を含む String 配列を返します。

プラグインがイメージメタデータを処理しない場合は、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 またはサポートされない名前の場合。