javax.imageio.spi

クラス IIOServiceProvider

java.lang.Object

javax.imageio.spi.IIOServiceProvider

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

RegisterableService

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

ImageInputStreamSpi, ImageOutputStreamSpi, ImageReaderWriterSpi, ImageTranscoderSpi

public abstract class IIOServiceProvider
extends Object
implements RegisterableService

すべてのイメージ入出力サービスプロバイダインタフェース (SPI) に共通する機能のスーパーインタフェースです。サービスプロバイダの詳細については、IIORegistry クラスのクラスコメントを参照してください。

関連項目:

IIORegistry, ImageReaderSpi, ImageWriterSpi, ImageTranscoderSpi, ImageInputStreamSpi

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected String	vendorName getVendorName から返される String で、最初は null です。
protected String	version getVersion から返される String で、最初は null です。

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

コンストラクタ

コンストラクタと説明
IIOServiceProvider() 空白の IIOServiceProvider を構築します。
IIOServiceProvider(String vendorName, String version) 指定されたベンダー名とバージョン識別子を使用して IIOServiceProvider を構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract String	getDescription(Locale locale) このサービスプロバイダとそれに関連する実装の、簡潔で判読可能な説明を返します。
String	getVendorName() このサービスプロバイダおよび関連する実装の構築を担当するベンダーの名前を返します。
String	getVersion() このサービスプロバイダとそれに関連する実装のバージョン番号を表す文字列を返します。
void	onDeregistration(ServiceRegistry registry, Class<?> category) Spi クラスが ServiceRegistry から登録解除されると常にコールバックが実行されます。
void	onRegistration(ServiceRegistry registry, Class<?> category) Spi クラスがインスタンス化されて ServiceRegistry に登録されたあとで 1 回だけ呼び出されるコールバックです。

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

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

フィールドの詳細

vendorName

protected String vendorName

getVendorName から返される String で、最初は null です。コンストラクタでこれを null 以外の値に設定する必要があります。

version

protected String version

getVersion から返される String で、最初は null です。コンストラクタでこれを null 以外の値に設定する必要があります。

コンストラクタの詳細

IIOServiceProvider

public IIOServiceProvider(String vendorName,
                  String version)

指定されたベンダー名とバージョン識別子を使用して IIOServiceProvider を構築します。

パラメータ:

vendorName - ベンダー名。

version - バージョン識別子。

例外:

IllegalArgumentException - vendorName が null の場合。

IllegalArgumentException - version が null の場合。

IIOServiceProvider

public IIOServiceProvider()

空白の IIOServiceProvider を構築します。getVendorName と getVersion メソッドが null 以外の値を返すようにするための、インスタンス変数の初期化やメソッド実装のオーバーライドはサブクラスで行う必要があります。

メソッドの詳細

onRegistration

public void onRegistration(ServiceRegistry registry,
                  Class<?> category)

Spi クラスがインスタンス化されて ServiceRegistry に登録されたあとで 1 回だけ呼び出されるコールバックです。これは、環境がこのサービスに適していること (たとえばネイティブライブラリがロードできること) を検証するために使用できます。サービスをその存在する環境で実行できない場合、レジストリから登録を解除する必要があります。

レジストリのみがこのメソッドを呼び出します。

デフォルト実装は何も実行しません。

定義:

onRegistration、インタフェース: RegisterableService

パラメータ:

registry - このオブジェクトが登録されている ServiceRegistry。

category - このオブジェクトが登録されているレジストリカテゴリを示す Class オブジェクト。

関連項目:

ServiceRegistry.registerServiceProvider(Object provider)

onDeregistration

public void onDeregistration(ServiceRegistry registry,
                    Class<?> category)

Spi クラスが ServiceRegistry から登録解除されると常にコールバックが実行されます。

レジストリのみがこのメソッドを呼び出します。

デフォルト実装は何も実行しません。

定義:

onDeregistration、インタフェース: RegisterableService

パラメータ:

registry - オブジェクトのすべてまたは一部が登録解除される ServiceRegistry。

category - このオブジェクトが登録解除されるレジストリカテゴリを示す Class オブジェクト。

関連項目:

ServiceRegistry.deregisterServiceProvider(Object provider)

getVendorName

public String getVendorName()

このサービスプロバイダおよび関連する実装の構築を担当するベンダーの名前を返します。ベンダー名はサービスプロバイダの選択で使用されるため、ローカライズされません。

デフォルトの実装では、vendorName インスタンス変数の値が返されます。

戻り値:

ベンダーの名前を含む null 以外の String。

getVersion

public String getVersion()

このサービスプロバイダとそれに関連する実装のバージョン番号を表す文字列を返します。バージョンはコード変換器が検出するサービスプロバイダの識別に使用されるため、このメソッドはローカライズされません。

デフォルトの実装では、version インスタンス変数の値が返されます。

戻り値:

このサービスプロバイダのバージョンを含む null 以外の String。

getDescription

public abstract String getDescription(Locale locale)

このサービスプロバイダとそれに関連する実装の、簡潔で判読可能な説明を返します。可能な場合、作成される文字列は指定された Locale にローカライズされます。

パラメータ:

locale - 返される値をローカライズする Locale。

戻り値:

このサービスプロバイダの説明を含む String。