DefinitionsUtil (Apache Struts API Documentation)

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

org.apache.struts.tiles
クラス DefinitionsUtil

java.lang.Object
  org.apache.struts.tiles.TilesUtil
      org.apache.struts.tiles.DefinitionsUtil

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

推奨されていません。 Use TilesUtil.createDefinitionsFactory(ServletContext, DefinitionsFactoryConfig)

public class DefinitionsUtil
extends TilesUtil
implements ComponentConstants

Utilities class for definitions factory. Also define userDebugLevel property (TODO to be moved from this class ?).

入れ子クラスの概要
`(パッケージプライベート) static class`	`DefinitionsUtil.ServletPropertiesMap` 推奨されていません。 Inner class.

フィールドの概要
`static java.lang.String`	`ACTION_DEFINITION` 推奨されていません。 Constant name used to store definition in jsp context.
`static java.lang.String`	`DEFINITIONS_CONFIG_USER_DEBUG_LEVEL` 推奨されていません。 Name of init property carrying debug level.
`static java.lang.String`	`DEFINITIONS_FACTORY` 推奨されていません。 Constant name used to store factory in context.
`static java.lang.String`	`DEFINITIONS_FACTORY_CLASSNAME` 推奨されていません。 Name of init property carrying factory class name.
`protected static org.apache.commons.logging.Log`	`log` 推奨されていません。 Commons Logging instance.
`static int`	`NO_DEBUG` 推奨されていません。 This will be removed in a release after Struts 1.2.
`static int`	`userDebugLevel` 推奨されていません。 This will be removed in a release after Struts 1.2.

クラス org.apache.struts.tiles.TilesUtil から継承したフィールド

tilesUtilImpl

インタフェース org.apache.struts.taglib.tiles.ComponentConstants から継承したフィールド

COMPONENT_CONTEXT, COMPONENT_SCOPE, EXCEPTION_KEY, LOCALE_KEY

コンストラクタの概要
`DefinitionsUtil()` 推奨されていません。

メソッドの概要
`static DefinitionsFactory`	`createDefinitionsFactory(javax.servlet.ServletContext servletContext, java.util.Map properties)` 推奨されていません。 Create default Definition factory.
`static DefinitionsFactory`	`createDefinitionsFactory(javax.servlet.ServletContext servletContext, java.util.Map properties, java.lang.String classname)` 推奨されていません。 Use createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig)
`static DefinitionsFactory`	`createDefinitionsFactory(javax.servlet.ServletContext servletContext, javax.servlet.ServletConfig servletConfig)` 推奨されていません。 Create Definition factory.
`static DefinitionsFactory`	`createDefinitionsFactory(javax.servlet.ServletContext servletContext, javax.servlet.ServletConfig servletConfig, boolean checkIfExist)` 推奨されていません。 Create Definition factory.
`static ComponentDefinition`	`getActionDefinition(javax.servlet.ServletRequest request)` 推奨されていません。 Get Definition stored in jsp context by an action.
`static DefinitionsFactory`	`getDefinitionsFactory(javax.servlet.ServletContext servletContext)` 推奨されていません。 Use `TilesUtil.getDefinitionsFactory(ServletRequest, ServletContext)`
`static void`	`populateDefinitionsFactoryConfig(DefinitionsFactoryConfig factoryConfig, javax.servlet.ServletConfig servletConfig)` 推奨されていません。 Populate Definition Factory Config from web.xml properties.
`protected static DefinitionsFactoryConfig`	`readFactoryConfig(javax.servlet.ServletConfig servletConfig)` 推奨されていません。 Create FactoryConfig and initialize it from web.xml.
`static void`	`removeActionDefinition(javax.servlet.ServletRequest request, ComponentDefinition definition)` 推奨されていません。 Remove Definition stored in jsp context.
`static void`	`setActionDefinition(javax.servlet.ServletRequest request, ComponentDefinition definition)` 推奨されていません。 Store definition in jsp context.

クラス org.apache.struts.tiles.TilesUtil から継承したメソッド

createDefinitionsFactory, doForward, doInclude, doInclude, getDefinition, getDefinitionsFactory, getTilesUtil, isTilesUtilImplSet, setTilesUtil, testReset

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

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

フィールドの詳細

log

protected static org.apache.commons.logging.Log log

推奨されていません。

Commons Logging instance.

userDebugLevel

public static int userDebugLevel

推奨されていません。 This will be removed in a release after Struts 1.2.

Global user defined debug level.

NO_DEBUG

public static final int NO_DEBUG

推奨されていません。 This will be removed in a release after Struts 1.2.

User Debug level.

関連項目:: 定数フィールド値

DEFINITIONS_CONFIG_USER_DEBUG_LEVEL

public static final java.lang.String DEFINITIONS_CONFIG_USER_DEBUG_LEVEL

推奨されていません。

Name of init property carrying debug level.

関連項目:: 定数フィールド値

DEFINITIONS_FACTORY_CLASSNAME

public static final java.lang.String DEFINITIONS_FACTORY_CLASSNAME

推奨されていません。

Name of init property carrying factory class name.

関連項目:: 定数フィールド値

DEFINITIONS_FACTORY

public static final java.lang.String DEFINITIONS_FACTORY

推奨されていません。

Constant name used to store factory in context.

関連項目:: 定数フィールド値

ACTION_DEFINITION

public static final java.lang.String ACTION_DEFINITION

推奨されていません。

Constant name used to store definition in jsp context. Used to pass definition from a Struts action to servlet forward.

関連項目:: 定数フィールド値

コンストラクタの詳細

DefinitionsUtil

public DefinitionsUtil()

推奨されていません。

メソッドの詳細

createDefinitionsFactory

public static DefinitionsFactory createDefinitionsFactory(javax.servlet.ServletContext servletContext,
                                                          java.util.Map properties,
                                                          java.lang.String classname)
                                                   throws DefinitionsFactoryException

推奨されていません。 Use createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig)

Create Definition factory. If a factory class name is provided, a factory of this class is created. Otherwise, default factory is created.

パラメータ:: classname - Class name of the factory to create.; servletContext - Servlet Context passed to newly created factory.; properties - Map of name/property used to initialize factory configuration object.
戻り値:: newly created factory.
例外:: DefinitionsFactoryException - If an error occur while initializing factory

createDefinitionsFactory

public static DefinitionsFactory createDefinitionsFactory(javax.servlet.ServletContext servletContext,
                                                          java.util.Map properties)
                                                   throws DefinitionsFactoryException

推奨されていません。

Create default Definition factory.

パラメータ:: servletContext - Servlet Context passed to newly created factory.; properties - Map of name/property used to initialize factory configuration object.
戻り値:: newly created factory of type ConfigurableDefinitionsFactory.
例外:: DefinitionsFactoryException - If an error occur while initializing factory

createDefinitionsFactory

public static DefinitionsFactory createDefinitionsFactory(javax.servlet.ServletContext servletContext,
                                                          javax.servlet.ServletConfig servletConfig)
                                                   throws DefinitionsFactoryException

推奨されていません。

Create Definition factory. Create configuration object from servlet web.xml file, then create ConfigurableDefinitionsFactory and initialized it with object.

Convenience method. Calls createDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig)

パラメータ:: servletContext - Servlet Context passed to newly created factory.; servletConfig - Servlet config containing parameters to be passed to factory configuration object.
戻り値:: newly created factory of type ConfigurableDefinitionsFactory.
例外:: DefinitionsFactoryException - If an error occur while initializing factory

createDefinitionsFactory

public static DefinitionsFactory createDefinitionsFactory(javax.servlet.ServletContext servletContext,
                                                          javax.servlet.ServletConfig servletConfig,
                                                          boolean checkIfExist)
                                                   throws DefinitionsFactoryException

推奨されていません。

Create Definition factory. Create configuration object from servlet web.xml file, then create ConfigurableDefinitionsFactory and initialized it with object.

If checkIfExist is true, start by checking if factory already exist. If yes, return it. If no, create a new one.

If checkIfExist is false, factory is always created.

Convenience method. Calls createDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig)

パラメータ:: servletContext - Servlet Context passed to newly created factory.; servletConfig - Servlet config containing parameters to be passed to factory configuration object.; checkIfExist - Check if factory already exist. If true and factory exist, return it. If true and factory doesn't exist, create it. If false, create it in all cases.
戻り値:: newly created factory of type ConfigurableDefinitionsFactory.
例外:: DefinitionsFactoryException - If an error occur while initializing factory

getDefinitionsFactory

public static DefinitionsFactory getDefinitionsFactory(javax.servlet.ServletContext servletContext)

推奨されていません。 Use TilesUtil.getDefinitionsFactory(ServletRequest, ServletContext)

Get definition factory from appropriate servlet context.

戻り値:: Definitions factory or null if not found.
導入されたバージョン:: 20020708

getActionDefinition

public static ComponentDefinition getActionDefinition(javax.servlet.ServletRequest request)

推奨されていません。

Get Definition stored in jsp context by an action.

戻り値:: ComponentDefinition or null if not found.

setActionDefinition

public static void setActionDefinition(javax.servlet.ServletRequest request,
                                       ComponentDefinition definition)

推奨されていません。

Store definition in jsp context. Mainly used by Struts to pass a definition defined in an Action to the forward.

removeActionDefinition

public static void removeActionDefinition(javax.servlet.ServletRequest request,
                                          ComponentDefinition definition)

推奨されていません。

Remove Definition stored in jsp context. Mainly used by Struts to pass a definition defined in an Action to the forward.

populateDefinitionsFactoryConfig

public static void populateDefinitionsFactoryConfig(DefinitionsFactoryConfig factoryConfig,
                                                    javax.servlet.ServletConfig servletConfig)
                                             throws java.lang.IllegalAccessException,
                                                    java.lang.reflect.InvocationTargetException

推奨されていません。

Populate Definition Factory Config from web.xml properties.

パラメータ:: factoryConfig - Definition Factory Config to populate.; servletConfig - Current servlet config containing web.xml properties.
例外:: java.lang.IllegalAccessException - if the caller does not have access to the property accessor method; java.lang.reflect.InvocationTargetException - if the property accessor method throws an exception
導入されたバージョン:: tiles 20020708
関連項目:: BeanUtils

readFactoryConfig

protected static DefinitionsFactoryConfig readFactoryConfig(javax.servlet.ServletConfig servletConfig)
                                                     throws DefinitionsFactoryException

推奨されていません。

Create FactoryConfig and initialize it from web.xml.

パラメータ:: servletConfig - ServletConfig for the module with which this plug in is associated
例外:: DefinitionsFactoryException - if this PlugIn cannot be successfully initialized