EE4J Web API 10.0.0 · jakarta.el.MethodExpression

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

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides jakarta.el.Expression.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	MethodExpression()

Method Summary

Modifier and Type	Method and Description
public abstract MethodInfo	Returns: an instance of `MethodInfo` containing information about the method the expression evaluated to. getMethodInfo(ELContext The context of this evaluation context) Evaluates the expression relative to the provided context, and returns information about the actual referenced method.
public MethodReference	Returns: This default implementation always returns `null` getMethodReference(ELContext The EL context for this evaluation context) Obtain the `MethodReference` for the method to which this method expression resolves.
public abstract Object	Returns: the result of the method invocation (`null` if the method has a `void` return type). invoke(ELContext The context of this evaluation. context, Object[] The parameters to pass to the method, or `null` if no parameters. params) If a String literal is specified as the expression, returns the String literal coerced to the expected return type of the method signature.
public boolean	Returns: `true` if the MethodExpression was created with parameters, `false` otherwise. isParametersProvided() Return whether this MethodExpression was created with parameters.

Inherited from jakarta.el.Expression:: equals getExpressionString hashCode isLiteralText

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides jakarta.el.Expression.serialVersionUID.

Constructor Detail

MethodExpression	back to summary
public MethodExpression()

Method Detail

getMethodInfo back to summary

getMethodInfo	back to summary
public abstract MethodInfo getMethodInfo(ELContext context) Evaluates the expression relative to the provided context, and returns information about the actual referenced method. Parameters context:ELContext The context of this evaluation Returns:MethodInfo an instance of `MethodInfo` containing information about the method the expression evaluated to. Exceptions NullPointerException: if context is `null` PropertyNotFoundException: if one of the property resolutions failed because a specified variable or property does not exist or is not readable. MethodNotFoundException: if no suitable method can be found. 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.

public abstract MethodInfo getMethodInfo(ELContext context)

Evaluates the expression relative to the provided context, and returns information about the actual referenced method.

Parameters

context:ELContext: The context of this evaluation

Returns:MethodInfo

an instance of MethodInfo containing information about the method the expression evaluated to.

Exceptions

NullPointerException:: if context is null
PropertyNotFoundException:: if one of the property resolutions failed because a specified variable or property does not exist or is not readable.
MethodNotFoundException:: if no suitable method can be found.
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.

getMethodReference back to summary

getMethodReference	back to summary
public MethodReference getMethodReference(ELContext context) Obtain the `MethodReference` for the method to which this method expression resolves. Parameters context:ELContext The EL context for this evaluation Returns:MethodReference This default implementation always returns `null` Exceptions NullPointerException: If the supplied context is `null` PropertyNotFoundException: If a property/variable resolution failed because no match was found or a match was found but was not readable MethodNotFoundException: If no matching method can be found ELException: Wraps any exception throw whilst resolving the property Since EL 5.0

public MethodReference getMethodReference(ELContext context)

Obtain the MethodReference for the method to which this method expression resolves.

Parameters

context:ELContext: The EL context for this evaluation

Returns:MethodReference

This default implementation always returns null

Exceptions

NullPointerException:: If the supplied context is null
PropertyNotFoundException:: If a property/variable resolution failed because no match was found or a match was found but was not readable
MethodNotFoundException:: If no matching method can be found
ELException:: Wraps any exception throw whilst resolving the property

Since

EL 5.0

invoke back to summary

invoke	back to summary
public abstract Object invoke(ELContext context, Object[] params) If a String literal is specified as the expression, returns the String literal coerced to the expected return type of the method signature. An `ELException` is thrown if `expectedReturnType` is void or if the coercion of the String literal to the `expectedReturnType` yields an error (see Section "1.18 Type Conversion" of the Jakarta Expression Language specification). If not a String literal, 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. Any parameters passed to this method is ignored if isLiteralText() or isParametersProvided() is true. Parameters context:ELContext The context of this evaluation. params:Object[] The parameters to pass to the method, or `null` if no parameters. Returns:Object the result of the method invocation (`null` if the method has a `void` return type). Exceptions NullPointerException: if context is `null` PropertyNotFoundException: if one of the property resolutions failed because a specified variable or property does not exist or is not readable. MethodNotFoundException: if no suitable method can be found. ELException: if a String literal is specified and expectedReturnType of the MethodExpression is void or if the coercion of the String literal to the expectedReturnType yields an error (see Section "1.18 Type Conversion"). 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.

public abstract Object invoke(ELContext context, Object[] params)

If a String literal is specified as the expression, returns the String literal coerced to the expected return type of the method signature. An ELException is thrown if expectedReturnType is void or if the coercion of the String literal to the expectedReturnType yields an error (see Section "1.18 Type Conversion" of the Jakarta Expression Language specification). If not a String literal, 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. Any parameters passed to this method is ignored if isLiteralText() or isParametersProvided() is true.

Parameters

context:ELContext: The context of this evaluation.
params:Object[]: The parameters to pass to the method, or null if no parameters.

Returns:Object

the result of the method invocation (null if the method has a void return type).

Exceptions

NullPointerException:

if context is null

PropertyNotFoundException:

if one of the property resolutions failed because a specified variable or property does not exist or is not readable.

MethodNotFoundException:

if no suitable method can be found.

ELException:

if a String literal is specified and expectedReturnType of the MethodExpression is void or if the coercion of the String literal to the expectedReturnType yields an error (see Section "1.18 Type Conversion").
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.

isParametersProvided back to summary

isParametersProvided	back to summary
public boolean isParametersProvided() Return whether this MethodExpression was created with parameters. This method must return `true` if and only if parameters are specified in the EL, using the expr-a.expr-b(...) syntax. Returns:boolean `true` if the MethodExpression was created with parameters, `false` otherwise. Since Jakarta Expression Language 2.2

public boolean isParametersProvided()

Return whether this MethodExpression was created with parameters.

This method must return true if and only if parameters are specified in the EL, using the expr-a.expr-b(...) syntax.

Returns:boolean: true if the MethodExpression was created with parameters, false otherwise.
Since: Jakarta Expression Language 2.2

public abstract Class MethodExpression

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail