FileDocCategorySizeDatePackage
MethodExpressionImpl.javaAPI DocApache Tomcat 6.0.1412327Fri Jul 20 04:20:36 BST 2007org.apache.el

MethodExpressionImpl

public final class MethodExpressionImpl extends MethodExpression implements Externalizable
An Expression that refers to a method on an object.

The {@link ExpressionFactory#createMethodExpression} method can be used to parse an expression string and return a concrete instance of MethodExpression that encapsulates the parsed expression. The {@link FunctionMapper} is used at parse time, not evaluation time, so one is not needed to evaluate an expression using this class. However, the {@link ELContext} is needed at evaluation time.

The {@link #getMethodInfo} and {@link #invoke} methods will evaluate the expression each time they are called. The {@link ELResolver} in the ELContext is used to resolve the top-level variables and to determine the behavior of the . and [] operators. For any of the two methods, the {@link ELResolver#getValue} method is used to resolve all properties up to but excluding the last one. This provides the base object on which the method appears. If the base object is null, a NullPointerException must be thrown. At the last resolution, the final property is then coerced to a String, which provides the name of the method to be found. A method matching the name and expected parameters provided at parse time is found and it is either queried or invoked (depending on the method called on this MethodExpression).

See the notes about comparison, serialization and immutability in the {@link Expression} javadocs.

see
javax.el.ELResolver
see
javax.el.Expression
see
javax.el.ExpressionFactory
see
javax.el.MethodExpression
author
Jacob Hookom [jacob@hookom.net]
version
$Change: 181177 $$DateTime: 2001/06/26 08:45:09 $$Author: markt $

Fields Summary
private Class
expectedType
private String
expr
private FunctionMapper
fnMapper
private VariableMapper
varMapper
private transient org.apache.el.parser.Node
node
private Class[]
paramTypes
Constructors Summary
public MethodExpressionImpl()

        super();
    
public MethodExpressionImpl(String expr, org.apache.el.parser.Node node, FunctionMapper fnMapper, VariableMapper varMapper, Class expectedType, Class[] paramTypes)

param
expr
param
node
param
fnMapper
param
expectedType
param
paramTypes

        super();
        this.expr = expr;
        this.node = node;
        this.fnMapper = fnMapper;
        this.varMapper = varMapper;
        this.expectedType = expectedType;
        this.paramTypes = paramTypes;
    
Methods Summary
public booleanequals(java.lang.Object obj)
Determines whether the specified object is equal to this Expression.

The result is true if and only if the argument is not null, is an Expression object that is the of the same type (ValueExpression or MethodExpression), and has an identical parsed representation.

Note that two expressions can be equal if their expression Strings are different. For example, ${fn1:foo()} and ${fn2:foo()} are equal if their corresponding FunctionMappers mapped fn1:foo and fn2:foo to the same method.

param
obj the Object to test for equality.
return
true if obj equals this Expression; false otherwise.
see
java.util.Hashtable
see
java.lang.Object#equals(java.lang.Object)

        return (obj instanceof MethodExpressionImpl && obj.hashCode() == this
                .hashCode());
    
public java.lang.StringgetExpressionString()
Returns the original String used to create this Expression, unmodified.

This is used for debugging purposes but also for the purposes of comparison (e.g. to ensure the expression in a configuration file has not changed).

This method does not provide sufficient information to re-create an expression. Two different expressions can have exactly the same expression string but different function mappings. Serialization should be used to save and restore the state of an Expression.

return
The original expression String.
see
javax.el.Expression#getExpressionString()

        return this.expr;
    
public javax.el.MethodInfogetMethodInfo(javax.el.ELContext context)
Evaluates the expression relative to the provided context, and returns information about the actual referenced method.

param
context The context of this evaluation
return
an instance of MethodInfo containing information about the method the expression evaluated to.
throws
NullPointerException if context is null or the base object is null on the last resolution.
throws
PropertyNotFoundException if one of the property resolutions failed because a specified variable or property does not exist or is not readable.
throws
MethodNotFoundException if no suitable method can be found.
throws
ELException if an exception was thrown while performing property or variable resolution. The thrown exception must be included as the cause property of this exception, if available.
see
javax.el.MethodExpression#getMethodInfo(javax.el.ELContext)

        Node n = this.getNode();
        EvaluationContext ctx = new EvaluationContext(context, this.fnMapper,
                this.varMapper);
        return n.getMethodInfo(ctx, this.paramTypes);
    
private org.apache.el.parser.NodegetNode()

return
throws
ELException

        if (this.node == null) {
            this.node = ExpressionBuilder.createNode(this.expr);
        }
        return this.node;
    
public inthashCode()
Returns the hash code for this Expression.

See the note in the {@link #equals} method on how two expressions can be equal if their expression Strings are different. Recall that if two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. Implementations must take special note and implement hashCode correctly.

return
The hash code for this Expression.
see
#equals
see
java.util.Hashtable
see
java.lang.Object#hashCode()

        return this.expr.hashCode();
    
public java.lang.Objectinvoke(javax.el.ELContext context, java.lang.Object[] params)
Evaluates the expression relative to the provided context, invokes the method that was found using the supplied parameters, and returns the result of the method invocation.

param
context The context of this evaluation.
param
params The parameters to pass to the method, or null if no parameters.
return
the result of the method invocation (null if the method has a void return type).
throws
NullPointerException if context is null or the base object is null on the last resolution.
throws
PropertyNotFoundException if one of the property resolutions failed because a specified variable or property does not exist or is not readable.
throws
MethodNotFoundException if no suitable method can be found.
throws
ELException if an exception was thrown while performing property or variable resolution. The thrown exception must be included as the cause property of this exception, if available. If the exception thrown is an InvocationTargetException, extract its cause and pass it to the ELException constructor.
see
javax.el.MethodExpression#invoke(javax.el.ELContext, java.lang.Object[])

        EvaluationContext ctx = new EvaluationContext(context, this.fnMapper,
                this.varMapper);
        return this.getNode().invoke(ctx, this.paramTypes, params);
    
public booleanisLiteralText()

        return false;
    
public voidreadExternal(java.io.ObjectInput in)

        this.expr = in.readUTF();
        String type = in.readUTF();
        if (!"".equals(type)) {
            this.expectedType = ReflectionUtil.forName(type);
        }
        this.paramTypes = ReflectionUtil.toTypeArray(((String[]) in
                .readObject()));
        this.fnMapper = (FunctionMapper) in.readObject();
        this.varMapper = (VariableMapper) in.readObject();
    
public voidwriteExternal(java.io.ObjectOutput out)

        out.writeUTF(this.expr);
        out.writeUTF((this.expectedType != null) ? this.expectedType.getName()
                : "");
        out.writeObject(ReflectionUtil.toTypeNameArray(this.paramTypes));
        out.writeObject(this.fnMapper);
        out.writeObject(this.varMapper);