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。