com.opensymphony.xwork2.ognl
Class OgnlValueStack

java.lang.Object
  com.opensymphony.xwork2.ognl.OgnlValueStack

All Implemented Interfaces:

ClearableValueStack, MemberAccessValueStack, ValueStack, Serializable

public class OgnlValueStack
extends Object
implements Serializable, ValueStack, ClearableValueStack, MemberAccessValueStack

Ognl implementation of a value stack that allows for dynamic Ognl expressions to be evaluated against it. When evaluating an expression, the stack will be searched down the stack, from the latest objects pushed in to the earliest, looking for a bean with a getter or setter for the given property or a method of the given name (depending on the expression being evaluated).

Version:

$Date: 2010-07-09 12:11:54 +0200 (Fri, 09 Jul 2010) $ $Id: OgnlValueStack.java 962472 2010-07-09 10:11:54Z lukaszlenart $

Author:

Patrick Lightbody, tm_jee

See Also:

Serialized Form

Field Summary

(package private) Map<String,Object>	context
(package private) Class	defaultType
private boolean	devMode
private static Logger	LOG
private boolean	logMissingProperties
private static String	MAP_IDENTIFIER_KEY
(package private) OgnlUtil	ognlUtil
(package private) Map<Object,Object>	overrides
(package private) CompoundRoot	root
(package private) SecurityMemberAccess	securityMemberAccess
private static long	serialVersionUID
static String	THROW_EXCEPTION_ON_FAILURE

Fields inherited from interface com.opensymphony.xwork2.util.ValueStack

REPORT_ERRORS_ON_NO_PROP, VALUE_STACK

Constructor Summary

protected	OgnlValueStack(ValueStack vs, XWorkConverter xworkConverter, CompoundRootAccessor accessor, boolean allowStaticAccess)
protected	OgnlValueStack(XWorkConverter xworkConverter, CompoundRootAccessor accessor, TextProvider prov, boolean allowStaticAccess)

Method Summary

private void	cleanUpContext(Map<String,Object> context)
void	clearContextValues() Remove all values from the context
private Object	findInContext(String name)
String	findString(String expr)
String	findString(String expr, boolean throwExceptionOnFailure)
Object	findValue(String expr) Find a value by evaluating the given expression against the stack in the default search order.
Object	findValue(String expr, boolean throwExceptionOnFailure)
Object	findValue(String expr, Class asType) Find a value by evaluating the given expression against the stack in the default search order.
Object	findValue(String expr, Class asType, boolean throwExceptionOnFailure)
Map<String,Object>	getContext() Gets the context for this value stack.
Map<Object,Object>	getExprOverrides() Gets the override map if anyone exists.
CompoundRoot	getRoot() Get the CompoundRoot which holds the objects pushed onto the stack
private Object	getValue(String expr, Class asType)
private Object	getValueUsingOgnl(String expr)
private Object	handleOgnlException(String expr, boolean throwExceptionOnFailure, ognl.OgnlException e)
private void	handleOgnlException(String expr, Object value, boolean throwExceptionOnFailure, ognl.OgnlException e)
private Object	handleOtherException(String expr, boolean throwExceptionOnFailure, Exception e)
private void	handleRuntimeException(String expr, Object value, boolean throwExceptionOnFailure, RuntimeException re)
private void	logLookupFailure(String expr, Exception e) Log a failed lookup, being more verbose when devMode=true.
private String	lookupForOverrides(String expr)
Object	peek() Get the object on the top of the stack without changing the stack.
Object	pop() Get the object on the top of the stack and remove it from the stack.
void	push(Object o) Put this object onto the top of the stack
private Object	readResolve()
private Map	retrieveSetMap()
void	set(String key, Object o) Sets an object on the stack with the given key so it is retrievable by ValueStack.findValue(String), ValueStack.findValue(String, Class)
void	setAcceptProperties(Set<Pattern> acceptedProperties)
void	setDefaultType(Class defaultType) Sets the default type to convert to if no type is provided when getting a value.
void	setDevMode(String mode)
void	setExcludeProperties(Set<Pattern> excludeProperties)
void	setExprOverrides(Map<Object,Object> overrides) Set a override map containing key -> values that takes precedent when doing find operations on the ValueStack.
void	setLogMissingProperties(String logMissingProperties)
void	setOgnlUtil(OgnlUtil ognlUtil)
protected void	setRoot(XWorkConverter xworkConverter, CompoundRootAccessor accessor, CompoundRoot compoundRoot, boolean allowStaticMethodAccess)
private void	setupExceptionOnFailure(boolean throwExceptionOnFailure)
void	setValue(String expr, Object value) Attempts to set a property on a bean in the stack with the given expression using the default search order.
void	setValue(String expr, Object value, boolean throwExceptionOnFailure) Attempts to set a property on a bean in the stack with the given expression using the default search order.
private boolean	shouldLogNoSuchPropertyWarning(ognl.OgnlException e)
private boolean	shouldUseOldMap(Object topObj) check if this is a Map put on the stack for setting if so just use the old map (reduces waste)
int	size() Get the number of objects in the stack
private Object	tryFindValue(String expr)
private Object	tryFindValue(String expr, Class asType)
private Object	tryFindValueWhenExpressionIsNotNull(String expr)
private Object	tryFindValueWhenExpressionIsNotNull(String expr, Class asType)
private void	trySetValue(String expr, Object value, boolean throwExceptionOnFailure, Map<String,Object> context)

Methods inherited from class java.lang.Object

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

Field Detail

THROW_EXCEPTION_ON_FAILURE

public static final String THROW_EXCEPTION_ON_FAILURE

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

MAP_IDENTIFIER_KEY

private static final String MAP_IDENTIFIER_KEY

See Also:

Constant Field Values

LOG

private static final Logger LOG

root

CompoundRoot root

context

transient Map<String,Object> context

defaultType

Class defaultType

overrides

Map<Object,Object> overrides

ognlUtil

transient OgnlUtil ognlUtil

securityMemberAccess

transient SecurityMemberAccess securityMemberAccess

devMode

private boolean devMode

logMissingProperties

private boolean logMissingProperties

Constructor Detail

OgnlValueStack

protected OgnlValueStack(XWorkConverter xworkConverter,
                         CompoundRootAccessor accessor,
                         TextProvider prov,
                         boolean allowStaticAccess)

OgnlValueStack

protected OgnlValueStack(ValueStack vs,
                         XWorkConverter xworkConverter,
                         CompoundRootAccessor accessor,
                         boolean allowStaticAccess)

Method Detail

setOgnlUtil

public void setOgnlUtil(OgnlUtil ognlUtil)

setRoot

protected void setRoot(XWorkConverter xworkConverter,
                       CompoundRootAccessor accessor,
                       CompoundRoot compoundRoot,
                       boolean allowStaticMethodAccess)

setDevMode

public void setDevMode(String mode)

setLogMissingProperties

public void setLogMissingProperties(String logMissingProperties)

getContext

public Map<String,Object> getContext()

Description copied from interface: ValueStack

Gets the context for this value stack. The context holds all the information in the value stack and it's surroundings.

Specified by:

getContext in interface ValueStack

Returns:

the context.

See Also:

ValueStack.getContext()

setDefaultType

public void setDefaultType(Class defaultType)

Description copied from interface: ValueStack

Sets the default type to convert to if no type is provided when getting a value.

Specified by:

setDefaultType in interface ValueStack

Parameters:

defaultType - the new default type

See Also:

ValueStack.setDefaultType(java.lang.Class)

setExprOverrides

public void setExprOverrides(Map<Object,Object> overrides)

Description copied from interface: ValueStack

Set a override map containing key -> values that takes precedent when doing find operations on the ValueStack.

See the unit test for ValueStackTest for examples.

Specified by:

setExprOverrides in interface ValueStack

Parameters:

overrides - overrides map.

See Also:

ValueStack.setExprOverrides(java.util.Map)

getExprOverrides

public Map<Object,Object> getExprOverrides()

Description copied from interface: ValueStack

Gets the override map if anyone exists.

Specified by:

getExprOverrides in interface ValueStack

Returns:

the override map, null if not set.

See Also:

ValueStack.getExprOverrides()

getRoot

public CompoundRoot getRoot()

Description copied from interface: ValueStack

Get the CompoundRoot which holds the objects pushed onto the stack

Specified by:

getRoot in interface ValueStack

Returns:

the root

See Also:

ValueStack.getRoot()

setValue

public void setValue(String expr,
                     Object value)

Description copied from interface: ValueStack

Attempts to set a property on a bean in the stack with the given expression using the default search order.

Specified by:

setValue in interface ValueStack

Parameters:

expr - the expression defining the path to the property to be set.

value - the value to be set into the named property

See Also:

ValueStack.setValue(java.lang.String, java.lang.Object)

setValue

public void setValue(String expr,
                     Object value,
                     boolean throwExceptionOnFailure)

Description copied from interface: ValueStack

Attempts to set a property on a bean in the stack with the given expression using the default search order.

Specified by:

setValue in interface ValueStack

Parameters:

expr - the expression defining the path to the property to be set.

value - the value to be set into the named property

throwExceptionOnFailure - a flag to tell whether an exception should be thrown if there is no property with the given name.

See Also:

ValueStack.setValue(java.lang.String, java.lang.Object, boolean)

trySetValue

private void trySetValue(String expr,
                         Object value,
                         boolean throwExceptionOnFailure,
                         Map<String,Object> context)
                  throws ognl.OgnlException

Throws:

ognl.OgnlException

cleanUpContext

private void cleanUpContext(Map<String,Object> context)

handleRuntimeException

private void handleRuntimeException(String expr,
                                    Object value,
                                    boolean throwExceptionOnFailure,
                                    RuntimeException re)

handleOgnlException

private void handleOgnlException(String expr,
                                 Object value,
                                 boolean throwExceptionOnFailure,
                                 ognl.OgnlException e)

findString

public String findString(String expr)

Specified by:

findString in interface ValueStack

See Also:

ValueStack.findString(java.lang.String)

findString

public String findString(String expr,
                         boolean throwExceptionOnFailure)

Specified by:

findString in interface ValueStack

findValue

public Object findValue(String expr,
                        boolean throwExceptionOnFailure)

Specified by:

findValue in interface ValueStack

See Also:

ValueStack.findValue(java.lang.String)

setupExceptionOnFailure

private void setupExceptionOnFailure(boolean throwExceptionOnFailure)

tryFindValueWhenExpressionIsNotNull

private Object tryFindValueWhenExpressionIsNotNull(String expr)
                                            throws ognl.OgnlException

Throws:

ognl.OgnlException

handleOtherException

private Object handleOtherException(String expr,
                                    boolean throwExceptionOnFailure,
                                    Exception e)

tryFindValue

private Object tryFindValue(String expr)
                     throws ognl.OgnlException

Throws:

ognl.OgnlException

lookupForOverrides

private String lookupForOverrides(String expr)

getValueUsingOgnl

private Object getValueUsingOgnl(String expr)
                          throws ognl.OgnlException

Throws:

ognl.OgnlException

findValue

public Object findValue(String expr)

Description copied from interface: ValueStack

Find a value by evaluating the given expression against the stack in the default search order.

Specified by:

findValue in interface ValueStack

Parameters:

expr - the expression giving the path of properties to navigate to find the property value to return

Returns:

the result of evaluating the expression

findValue

public Object findValue(String expr,
                        Class asType,
                        boolean throwExceptionOnFailure)

Specified by:

findValue in interface ValueStack

See Also:

ValueStack.findValue(java.lang.String, java.lang.Class)

tryFindValueWhenExpressionIsNotNull

private Object tryFindValueWhenExpressionIsNotNull(String expr,
                                                   Class asType)
                                            throws ognl.OgnlException

Throws:

ognl.OgnlException

handleOgnlException

private Object handleOgnlException(String expr,
                                   boolean throwExceptionOnFailure,
                                   ognl.OgnlException e)

shouldLogNoSuchPropertyWarning

private boolean shouldLogNoSuchPropertyWarning(ognl.OgnlException e)

tryFindValue

private Object tryFindValue(String expr,
                            Class asType)
                     throws ognl.OgnlException

Throws:

ognl.OgnlException

getValue

private Object getValue(String expr,
                        Class asType)
                 throws ognl.OgnlException

Throws:

ognl.OgnlException

findInContext

private Object findInContext(String name)

findValue

public Object findValue(String expr,
                        Class asType)

Description copied from interface: ValueStack

Find a value by evaluating the given expression against the stack in the default search order.

Specified by:

findValue in interface ValueStack

Parameters:

expr - the expression giving the path of properties to navigate to find the property value to return

asType - the type to convert the return value to

Returns:

the result of evaluating the expression

logLookupFailure

private void logLookupFailure(String expr,
                              Exception e)

Log a failed lookup, being more verbose when devMode=true.

Parameters:

expr - The failed expression

e - The thrown exception.

peek

public Object peek()

Description copied from interface: ValueStack

Get the object on the top of the stack without changing the stack.

Specified by:

peek in interface ValueStack

Returns:

the object on the top.

See Also:

ValueStack.peek()

pop

public Object pop()

Description copied from interface: ValueStack

Get the object on the top of the stack and remove it from the stack.

Specified by:

pop in interface ValueStack

Returns:

the object on the top of the stack

See Also:

ValueStack.pop()

push

public void push(Object o)

Description copied from interface: ValueStack

Put this object onto the top of the stack

Specified by:

push in interface ValueStack

Parameters:

o - the object to be pushed onto the stack

See Also:

ValueStack.push(java.lang.Object)

set

public void set(String key,
                Object o)

Description copied from interface: ValueStack

Sets an object on the stack with the given key so it is retrievable by ValueStack.findValue(String), ValueStack.findValue(String, Class)

Specified by:

set in interface ValueStack

Parameters:

key - the key

o - the object

See Also:

ValueStack.set(java.lang.String, java.lang.Object)

retrieveSetMap

private Map retrieveSetMap()

shouldUseOldMap

private boolean shouldUseOldMap(Object topObj)

check if this is a Map put on the stack for setting if so just use the old map (reduces waste)

size

public int size()

Description copied from interface: ValueStack

Get the number of objects in the stack

Specified by:

size in interface ValueStack

Returns:

the number of objects in the stack

See Also:

ValueStack.size()

readResolve

private Object readResolve()

clearContextValues

public void clearContextValues()

Description copied from interface: ClearableValueStack

Remove all values from the context

Specified by:

clearContextValues in interface ClearableValueStack

setAcceptProperties

public void setAcceptProperties(Set<Pattern> acceptedProperties)

Specified by:

setAcceptProperties in interface MemberAccessValueStack

setExcludeProperties

public void setExcludeProperties(Set<Pattern> excludeProperties)

Specified by:

setExcludeProperties in interface MemberAccessValueStack