Package org.apache.commons.ognl

Class ASTMethod

java.lang.Object

org.apache.commons.ognl.SimpleNode

org.apache.commons.ognl.ASTMethod

All Implemented Interfaces:

java.io.Serializable, OrderedReturn, JavaSource, Node, NodeType

public class ASTMethod
extends SimpleNode
implements OrderedReturn, NodeType

$Id$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	coreExpression
private java.lang.Class	getterClass
private java.lang.String	lastExpression
private java.lang.String	methodName

Fields inherited from class org.apache.commons.ognl.SimpleNode

children, id, parent, parser

Constructor Summary

Constructors

Constructor	Description
ASTMethod(int id)
ASTMethod(OgnlParser p, int id)

Method Summary

Modifier and Type	Method	Description
<R,P> R	accept(NodeVisitor<? extends R,? super P> visitor, P data)	Supports the Visitor pattern.
java.lang.String	getCoreExpression()	Get the core expression to execute first before any return foo logic is started.
java.lang.Class	getGetterClass()	The type returned from the expression - if any.
java.lang.String	getLastExpression()	Gets the last expression to be pre-pended with a return <expression> block.
java.lang.String	getMethodName()	Returns the method name that this node will call.
java.lang.Class	getSetterClass()	The type used to set the value - if any.
protected java.lang.Object	getValueBody(OgnlContext context, java.lang.Object source)	Subclasses implement this method to do the actual work of extracting the appropriate value from the source object.
void	setMethodName(java.lang.String methodName)	Called from parser action.
java.lang.String	toGetSourceString(OgnlContext context, java.lang.Object target)	Expected to return a java source representation of itself such that it could be turned into a literal java expression to be compiled and executed for ExpressionAccessor.get(OgnlContext, Object) calls.
java.lang.String	toSetSourceString(OgnlContext context, java.lang.Object target)	Expected to return a java source representation of itself such that it could be turned into a literal java expression to be compiled and executed for ExpressionAccessor.get(OgnlContext, Object) calls.

Methods inherited from class org.apache.commons.ognl.SimpleNode

dump, evaluateGetValueBody, evaluateSetValueBody, flattenTree, getAccessor, getIndexInParent, getNextSibling, getValue, isConstant, isEvalChain, isNodeConstant, isNodeSimpleProperty, isSimpleNavigationChain, isSimpleProperty, jjtAddChild, jjtClose, jjtGetChild, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetParent, lastChild, setAccessor, setValue, setValueBody, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

methodName

private java.lang.String methodName

lastExpression

private java.lang.String lastExpression

coreExpression

private java.lang.String coreExpression

getterClass

private java.lang.Class getterClass

Constructor Detail

ASTMethod

public ASTMethod(int id)

ASTMethod

public ASTMethod(OgnlParser p,
                 int id)

Method Detail

setMethodName

public void setMethodName(java.lang.String methodName)

Called from parser action.

Parameters:

methodName - sets the name of the method

getMethodName

public java.lang.String getMethodName()

Returns the method name that this node will call.

Returns:

the method name

getValueBody

protected java.lang.Object getValueBody(OgnlContext context,
                                        java.lang.Object source)
                                 throws OgnlException

Description copied from class: SimpleNode

Subclasses implement this method to do the actual work of extracting the appropriate value from the source object.

Specified by:

getValueBody in class SimpleNode

Throws:

OgnlException

getLastExpression

public java.lang.String getLastExpression()

Description copied from interface: OrderedReturn

Gets the last expression to be pre-pended with a return <expression> block.

Specified by:

getLastExpression in interface OrderedReturn

Returns:

The expression representing the return portion of a statement;

getCoreExpression

public java.lang.String getCoreExpression()

Description copied from interface: OrderedReturn

Get the core expression to execute first before any return foo logic is started.

Specified by:

getCoreExpression in interface OrderedReturn

Returns:

The core standalone expression that shouldn't be pre-pended with a return keyword.

getGetterClass

public java.lang.Class getGetterClass()

Description copied from interface: NodeType

The type returned from the expression - if any.

Specified by:

getGetterClass in interface NodeType

Returns:

The type.

getSetterClass

public java.lang.Class getSetterClass()

Description copied from interface: NodeType

The type used to set the value - if any.

Specified by:

getSetterClass in interface NodeType

Returns:

The type.

toGetSourceString

public java.lang.String toGetSourceString(OgnlContext context,
                                          java.lang.Object target)

Description copied from interface: JavaSource

Expected to return a java source representation of itself such that it could be turned into a literal java expression to be compiled and executed for ExpressionAccessor.get(OgnlContext, Object) calls.

Specified by:

toGetSourceString in interface JavaSource

Overrides:

toGetSourceString in class SimpleNode

Returns:

Literal java string representation of an object get.

toSetSourceString

public java.lang.String toSetSourceString(OgnlContext context,
                                          java.lang.Object target)

Description copied from interface: JavaSource

Expected to return a java source representation of itself such that it could be turned into a literal java expression to be compiled and executed for ExpressionAccessor.get(OgnlContext, Object) calls.

Specified by:

toSetSourceString in interface JavaSource

Overrides:

toSetSourceString in class SimpleNode

Returns:

Literal java string representation of an object get.

accept

public <R,P> R accept(NodeVisitor<? extends R,? super P> visitor,
                            P data)
                     throws OgnlException

Description copied from interface: Node

Supports the Visitor pattern. The method which corresponds to the runtime type of this Node will be called.

Specified by:

accept in interface Node

Type Parameters:

R - The return type of the visitor.visit method.

P - The type of the second parameter type.

Parameters:

visitor - The visitor to accept.

data - The second parameter to pass through to visitor.visit

Returns:

the value returned by visitor.visit

Throws:

OgnlException