org.apache.struts.taglib.tiles.util

Class TagUtils

public class TagUtils extends 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 booleandebug
Debug flag
Method Summary
static ObjectfindAttribute(String beanName, PageContext pageContext)
Search attribute in different contexts.
static ObjectgetAttribute(String beanName, int scope, PageContext pageContext)
Get object from requested context.
static ComponentDefinitiongetComponentDefinition(String name, PageContext pageContext)
Get component definition by its name.
static ObjectgetProperty(Object bean, String name)
Return the value of the specified property of the specified bean, no matter which property reference format is used, with no type conversions.
static ObjectgetRealValueFromBean(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 intgetScope(String scopeName, int defaultValue)
Get scope value from string value
static ObjectretrieveBean(String beanName, String scopeName, PageContext pageContext)
Retrieve bean from page context, using specified scope.
static voidsaveException(PageContext pageContext, Throwable exception)
Save the specified exception as a request attribute for later use.
static voidsetAttribute(PageContext pageContext, String name, Object value, String scope)
Store bean in requested context.
static voidsetAttribute(PageContext pageContext, String name, Object beanValue)
Store bean in REQUEST_SCOPE context.

Field Detail

debug

public static final boolean debug
Debug flag

Method Detail

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)
Get component definition by its name.

Parameters: name Definition name. pageContext The PageContext for the current page.

Throws: JspException -

getProperty

public static Object getProperty(Object bean, String name)

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.

Throws: IllegalAccessException if the caller does not have access to the property accessor method InvocationTargetException if the property accessor method throws an exception NoSuchMethodException if an accessor method for this propety cannot be found.

getRealValueFromBean

public 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.

Parameters: pageContext Page context to be searched. 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.

Throws: JspException Scope name is not recognized as a valid scope JspException if the specified bean is not found JspException if accessing this property causes an IllegalAccessException, IllegalArgumentException, InvocationTargetException, or NoSuchMethodException

getScope

public static int getScope(String scopeName, int defaultValue)
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.

Throws: JspException Scope name is not recognized as a valid scope.

retrieveBean

public static Object retrieveBean(String beanName, String scopeName, PageContext pageContext)
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.

Throws: JspException Scope name is not recognized as a valid scope.

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 value, String scope)
Store bean in requested context. If scope is null, save it in REQUEST_SCOPE context.

Parameters: pageContext Current pageContext. name Name of the bean. scope Scope under which bean is saved (page, request, session, application) or null to store in request() instead. value Bean value to store.

Throws: JspException Scope name is not recognized as a valid scope

setAttribute

public static void setAttribute(PageContext pageContext, String name, Object beanValue)
Store bean in REQUEST_SCOPE context.

Parameters: pageContext Current pageContext. name Name of the bean. beanValue Bean value to store.

Throws: JspException Scope name is not recognized as a valid scope

Copyright © 2000-2008 - The Apache Software Foundation