org.apache.struts.taglib.tiles.util

Class TagUtils


public class TagUtils
extends java.lang.Object

Collection of utilities. This class also serves as an interface between Components and Struts. If you want to rip away Struts, simply reimplement some methods in this class. You can copy them from Struts.

Field Summary

static boolean
debug
Debug flag

Method Summary

static Object
findAttribute(String beanName, PageContext pageContext)
Search attribute in different contexts.
static Object
getAttribute(String beanName, int scope, PageContext pageContext)
Get object from requested context.
static ComponentDefinition
getComponentDefinition(String name, PageContext pageContext)
Get component definition by its name.
static Object
getProperty(Object bean, String name)
Deprecated. Use PropertyUtils.getProperty() directly.
static Object
getRealValueFromBean(String beanName, String beanProperty, String beanScope, PageContext pageContext)
Locate and return the specified property of the specified bean, from an optionally specified scope, in the specified page context.
static int
getScope(String scopeName, int defaultValue)
Get scope value from string value
static Object
retrieveBean(String beanName, String scopeName, PageContext pageContext)
Retrieve bean from page context, using specified scope.
static void
saveException(PageContext pageContext, Throwable exception)
Save the specified exception as a request attribute for later use.
static void
setAttribute(PageContext pageContext, String name, Object beanValue)
Store bean in REQUEST_SCOPE context.
static void
setAttribute(PageContext pageContext, String name, Object value, String scope)
Store bean in requested context.

Field Details

debug

public static final boolean debug
Debug flag
Field Value:
true

Method Details

findAttribute

public static Object findAttribute(String beanName,
                                   PageContext pageContext)
Search attribute in different contexts. First, check in component context, then use pageContext.findAttribute().
Parameters:
beanName - Name of bean to retrieve.
pageContext - Current pageContext.
Returns:
Requested bean or null if not found.

getAttribute

public static Object getAttribute(String beanName,
                                  int scope,
                                  PageContext pageContext)
Get object from requested context. Return null if not found. Context can be "component" or normal JSP contexts.
Parameters:
beanName - Name of bean to retrieve.
scope - Scope from which bean must be retrieved.
pageContext - Current pageContext.
Returns:
Requested bean or null if not found.

getComponentDefinition

public static ComponentDefinition getComponentDefinition(String name,
                                                         PageContext pageContext)
            throws JspException
Get component definition by its name.
Parameters:
name - Definition name.
pageContext - The PageContext for the current page.

getProperty

public static Object getProperty(Object bean,
                                 String name)
            throws IllegalAccessException,
                   InvocationTargetException,
                   NoSuchMethodException

Deprecated. Use PropertyUtils.getProperty() directly. This will be removed after Struts 1.2.

Return the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.
Parameters:
bean - Bean whose property is to be extracted.
name - Possibly indexed and/or nested name of the property to be extracted.

getRealValueFromBean

public static Object getRealValueFromBean(String beanName,
                                          String beanProperty,
                                          String beanScope,
                                          PageContext pageContext)
            throws JspException
Locate and return the specified property of the specified bean, from an optionally specified scope, in the specified page context.
Parameters:
beanName - Name of the bean to be retrieved.
beanProperty - Name of the property to be retrieved, or null to retrieve the bean itself.
beanScope - Scope to be searched (page, request, session, application) or null to use findAttribute() instead.
pageContext - Page context to be searched.

getScope

public static int getScope(String scopeName,
                           int defaultValue)
            throws JspException
Get scope value from string value
Parameters:
scopeName - Scope as a String.
defaultValue - Returned default value, if not found.
Returns:
Scope as an int, or defaultValue if scope is null.

retrieveBean

public static Object retrieveBean(String beanName,
                                  String scopeName,
                                  PageContext pageContext)
            throws JspException
Retrieve bean from page context, using specified scope. If scope is not set, use findAttribute().
Parameters:
beanName - Name of bean to retrieve.
scopeName - Scope or null. If null, bean is searched using findAttribute().
pageContext - Current pageContext.
Returns:
Requested bean or null if not found.

saveException

public static void saveException(PageContext pageContext,
                                 Throwable exception)
Save the specified exception as a request attribute for later use.
Parameters:
pageContext - The PageContext for the current page.
exception - The exception to be saved.

setAttribute

public static void setAttribute(PageContext pageContext,
                                String name,
                                Object beanValue)
            throws JspException
Store bean in REQUEST_SCOPE context.
Parameters:
pageContext - Current pageContext.
name - Name of the bean.
beanValue - Bean value to store.

setAttribute

public static void setAttribute(PageContext pageContext,
                                String name,
                                Object value,
                                String scope)
            throws JspException
Store bean in requested context. If scope is null, save it in REQUEST_SCOPE context.
Parameters:
pageContext - Current pageContext.
name - Name of the bean.
value - Bean value to store.
scope - Scope under which bean is saved (page, request, session, application) or null to store in request() instead.

Copyright B) 2000-2007 - The Apache Software Foundation