rydeen.spi
クラス AbstractProcessorService

java.lang.Object
  rydeen.spi.AbstractProcessorService

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

ProcessorService

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

NopProcessorService, StringEncryptObfuscatorService

public abstract class AbstractProcessorService
extends Object
implements ProcessorService

ProcessorServiceのデフォルト実装を含む抽象クラス．

作成者:

Haruaki Tamada

コンストラクタの概要

protected

AbstractProcessorService() サブクラスのためのコンストラクタ．

メソッドの概要

protected abstract Arguments	createDefaultArguments() このSPIが提供する処理器のパラメータとその初期値を表すArgumentsを作成して返します．
protected abstract Processor	createProcessor() Processorを作成して返します．
protected abstract Provider	createProvider() このProcessorの提供者情報を作成して返します．
Author[]	getAuthors() このSPI並びにProcessor の作成者のリストを返します．
Arguments	getDefaultArguments() このProviderが定義するProcessorのデフォルトの Argumentsを返します．
abstract String	getDescription() このSPIが作成する処理器の説明を返します．
Organization	getOrganization() このSPIが作成する処理器を作成した団体情報を返します．
Processor	getProcessor() このSPIに対応する処理器を作成して返します．
abstract String	getProcessorName() このSPIが作成する処理器の名前を返します．
Provider	getProvider() このSPIが作成する処理器の提供者情報を返します．

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

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

コンストラクタの詳細

AbstractProcessorService

protected AbstractProcessorService()

サブクラスのためのコンストラクタ．

メソッドの詳細

createDefaultArguments

protected abstract Arguments createDefaultArguments()

このSPIが提供する処理器のパラメータとその初期値を表すArgumentsを作成して返します． このメソッドはインスタンス化されたときに一度だけ実行されます．

関連項目:

getDefaultArguments()

createProvider

protected abstract Provider createProvider()

このProcessorの提供者情報を作成して返します． このメソッドはインスタンス化されたときに一度だけ実行されます．

関連項目:

getProvider()

createProcessor

protected abstract Processor createProcessor()
                                      throws ProcessorBuildException

Processorを作成して返します． このメソッドは必要に応じて何度も呼び出されます．

例外:

ProcessorBuildException

getAuthors

public final Author[] getAuthors()

インタフェース ProcessorService の記述:

このSPI並びにProcessor の作成者のリストを返します．

定義:

インタフェース ProcessorService 内の getAuthors

戻り値:

作成者のリスト

getDefaultArguments

public final Arguments getDefaultArguments()

このProviderが定義するProcessorのデフォルトの Argumentsを返します． 返されたArgumentsに変更を加えても，デフォルト値に影響を与えません．

デフォルト値はどのような方法であっても変更不可能です． 何らかの理由により，デフォルト値を変更したい場合は，新たな Processorを定義し直さなければいけません．

返されたArgumentsの値を変更したい場合，返されたオブジェクトに対して， Arguments#putValue メソッドを呼び出して変更してください． この変更は自由で，かつ，デフォルト値に全く影響を与えません．

定義:

インタフェース ProcessorService 内の getDefaultArguments

戻り値:

初期設定値

getDescription

public abstract String getDescription()

このSPIが作成する処理器の説明を返します．

定義:

インタフェース ProcessorService 内の getDescription

戻り値:

このSPIが対応するProcessorの解説

getOrganization

public final Organization getOrganization()

このSPIが作成する処理器を作成した団体情報を返します． getProvider()がnullを返すとき，このメソッドはnullを返します．

定義:

インタフェース ProcessorService 内の getOrganization

戻り値:

作成者の所属する団体

関連項目:

Provider.getOrganization()

getProcessor

public final Processor getProcessor()
                             throws ProcessorBuildException

このSPIに対応する処理器を作成して返します． Processorの作成に失敗した場合，ProcessorBuildExceptionが投げられます．

定義:

インタフェース ProcessorService 内の getProcessor

戻り値:

作成されたProcessorオブジェクト

例外:

ProcessorBuildException

getProcessorName

public abstract String getProcessorName()

このSPIが作成する処理器の名前を返します．

定義:

インタフェース ProcessorService 内の getProcessorName

戻り値:

対応するProcessorの名前

getProvider

public final Provider getProvider()

このSPIが作成する処理器の提供者情報を返します．

定義:

インタフェース ProcessorService 内の getProvider

戻り値:

作成者とその団体を収めたオブジェクト

関連項目:

createProvider()