org.apache.struts.tiles.definition
クラス ComponentDefinitionsFactoryWrapper

java.lang.Object
  org.apache.struts.tiles.definition.ComponentDefinitionsFactoryWrapper

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

DefinitionsFactory, java.io.Serializable

public class ComponentDefinitionsFactoryWrapper

extends java.lang.Object

implements DefinitionsFactory

Wrapper from new definition factory interface to old interface. This class provides mapping from the old interface's life cycle to the new life cycle.

導入されたバージョン:

20020708

関連項目:

直列化された形式

フィールドの概要

private DefinitionsFactoryConfig	config Factory configuration,
private ComponentDefinitionsFactory	factory The underlying factory.

コンストラクタの概要

ComponentDefinitionsFactoryWrapper()
Constructor.

ComponentDefinitionsFactoryWrapper(ComponentDefinitionsFactory factory)
Constructor.

メソッドの概要

static java.util.Map	createConfigMap(DefinitionsFactoryConfig config) Create map of configuration attributes from configuration object.
protected ComponentDefinitionsFactory	createFactoryInstance(java.lang.String classname) Create Definition factory from provided classname which must implement ComponentDefinitionsFactory.
void	destroy() Do nothing because old life cycle has no equivalent.
DefinitionsFactoryConfig	getConfig() Get underlying factory configuration.
ComponentDefinition	getDefinition(java.lang.String name, javax.servlet.ServletRequest request, javax.servlet.ServletContext servletContext) Get requested definition.
ComponentDefinitionsFactory	getInternalFactory() Get internal factory.
void	init(DefinitionsFactoryConfig config, javax.servlet.ServletContext servletContext) Call underlying factory init method.
void	setConfig(DefinitionsFactoryConfig config, javax.servlet.ServletContext servletContext) Set underlying factory configuration.
java.lang.String	toString() Return String representation.

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

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

フィールドの詳細

factory

private ComponentDefinitionsFactory factory

The underlying factory.

config

private DefinitionsFactoryConfig config

Factory configuration,

コンストラクタの詳細

ComponentDefinitionsFactoryWrapper

public ComponentDefinitionsFactoryWrapper(ComponentDefinitionsFactory factory)

Constructor. Create new wrapper for specified factory.

パラメータ:

factory - The factory to create a wrapper for.

ComponentDefinitionsFactoryWrapper

public ComponentDefinitionsFactoryWrapper()

Constructor. Create new wrapper. The config object passed to init method should reference a factory implementing ComponentDefinitionsFactory.

メソッドの詳細

getDefinition

public ComponentDefinition getDefinition(java.lang.String name,
                                         javax.servlet.ServletRequest request,
                                         javax.servlet.ServletContext servletContext)
                                  throws NoSuchDefinitionException,
                                         DefinitionsFactoryException

Get requested definition.

定義:

インタフェース DefinitionsFactory 内の getDefinition

パラメータ:

name - Name of the definition.

request - The request we are processing.

servletContext - Our servlet context.

戻り値:

ComponentDefition

例外:

DefinitionsFactoryException - An error occur while getting definition.

NoSuchDefinitionException - No definition found for specified name Implementation can throw more accurate exception as a subclass of this exception

init

public void init(DefinitionsFactoryConfig config,
                 javax.servlet.ServletContext servletContext)
          throws DefinitionsFactoryException

Call underlying factory init method.

定義:

インタフェース DefinitionsFactory 内の init

パラメータ:

config - DefinitionsFactoryConfig.

servletContext - Our servlet context.

例外:

DefinitionsFactoryException - An error occur during initialization.

destroy

public void destroy()

Do nothing because old life cycle has no equivalent.

定義:

インタフェース DefinitionsFactory 内の destroy

setConfig

public void setConfig(DefinitionsFactoryConfig config,
                      javax.servlet.ServletContext servletContext)
               throws DefinitionsFactoryException

Set underlying factory configuration.

定義:

インタフェース DefinitionsFactory 内の setConfig

パラメータ:

config - DefinitionsFactoryConfig to use.

servletContext - Our servlet context.

例外:

DefinitionsFactoryException - An error occur during initialization.

getConfig

public DefinitionsFactoryConfig getConfig()

Get underlying factory configuration.

定義:

インタフェース DefinitionsFactory 内の getConfig

戻り値:

DefinitionsFactoryConfig.

getInternalFactory

public ComponentDefinitionsFactory getInternalFactory()

Get internal factory.

戻り値:

The internal ComponentDefitionsFactory.

createFactoryInstance

protected ComponentDefinitionsFactory createFactoryInstance(java.lang.String classname)
                                                     throws DefinitionsFactoryException

Create Definition factory from provided classname which must implement ComponentDefinitionsFactory. Factory class must extend DefinitionsFactory.

パラメータ:

classname - Class name of the factory to create.

戻り値:

newly created factory.

例外:

DefinitionsFactoryException - If an error occur while initializing factory

toString

public java.lang.String toString()

Return String representation. Calls toString() on underlying factory.

戻り値:

String representation.

createConfigMap

public static java.util.Map createConfigMap(DefinitionsFactoryConfig config)

Create map of configuration attributes from configuration object. Mapping is done between old names and new names.

パラメータ:

config - The DefinitionsFactoryConfig to use.

戻り値:

Map Map of name/value pairs.