Save This Page
Home » apache-tomcat-6.0.16-src » org.apache » el » [javadoc | source]
org.apache.el
public final class: MethodExpressionImpl [javadoc | source]
java.lang.Object
   javax.el.MethodExpression
      org.apache.el.MethodExpressionImpl

All Implemented Interfaces:
    Externalizable

An Expression that refers to a method on an object.

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

The #getMethodInfo and #invoke methods will evaluate the expression each time they are called. The 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 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 Expression javadocs.

Constructor:
 public MethodExpressionImpl() 
 public MethodExpressionImpl(String expr,
    Node node,
    FunctionMapper fnMapper,
    VariableMapper varMapper,
    Class expectedType,
    Class[] paramTypes) 
    Parameters:
    expr -
    node -
    fnMapper -
    expectedType -
    paramTypes -
Method from org.apache.el.MethodExpressionImpl Summary:
equals,   getExpressionString,   getMethodInfo,   hashCode,   invoke,   isLiteralText,   readExternal,   writeExternal
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.el.MethodExpressionImpl Detail:
 public boolean equals(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.

 public String getExpressionString() 
    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.

 public MethodInfo getMethodInfo(ELContext context) throws MethodNotFoundException, PropertyNotFoundException, ELException 
    Evaluates the expression relative to the provided context, and returns information about the actual referenced method.
 public int hashCode() 
    Returns the hash code for this Expression.

    See the note in the #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.

 public Object invoke(ELContext context,
    Object[] params) throws MethodNotFoundException, PropertyNotFoundException, ELException 
    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.
 public boolean isLiteralText() 
 public  void readExternal(ObjectInput in) throws ClassNotFoundException, IOException 
 public  void writeExternal(ObjectOutput out) throws IOException