Class ELResolver
- java.lang.Object
-
- jakarta.el.ELResolver
-
- Direct Known Subclasses:
ArrayELResolver
,BeanELResolver
,BeanNameELResolver
,CompositeELResolver
,ImplicitObjectELResolver
,ImportELResolver
,ListELResolver
,MapELResolver
,NotFoundELResolver
,ResourceBundleELResolver
,ScopedAttributeELResolver
,StaticFieldELResolver
,TypeConverter
public abstract class ELResolver extends Object
Enables customization of variable, property, method call, and type conversion resolution behavior for Jakarta Expression Language expression evaluation.While evaluating an expression, the
ELResolver
associated with theELContext
is consulted to do the initial resolution of the first variable of an expression. It is also consulted when a.
or[]
operator is encountered.For example, in the Jakarta Expression Language expression
${employee.lastName}
, theELResolver
determines what objectemployee
refers to, and what it means to get thelastName
property on that object.Most methods in this class accept a
base
andproperty
parameter. In the case of variable resolution (e.g. determining whatemployee
refers to in${employee.lastName}
), thebase
parameter will benull
and theproperty
parameter will always be of typeString
. In this case, if theproperty
is not aString
, the behavior of theELResolver
is undefined.In the case of property resolution, the
base
parameter identifies the base object and theproperty
object identifies the property on that base. For example, in the expression${employee.lastName}
,base
is the result of the variable resolution foremployee
andproperty
is the string"lastName"
. In the expression${y[x]}
,base
is the result of the variable resolution fory
andproperty
is the result of the variable resolution forx
.In the case of method call resolution, the
base
parameter identifies the base object and themethod
parameter identifies a method on that base. In the case of overloaded methods, theparamTypes
parameter can be optionally used to identify a method. Theparams
parameter are the parameters for the method call, and can also be used for resolving overloaded methods when theparamTypes
parameter is not specified.In the case of type conversion resolution, the
obj
parameter identifies the source object and thetargetType
parameter identifies the target type the source to covert to.Though only a single
ELResolver
is associated with anELContext
, there are usually multiple resolvers considered for any given variable or property resolution.ELResolver
s are combined together usingCompositeELResolver
s, to define rich semantics for evaluating an expression.For the
getValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object)
,getType(jakarta.el.ELContext, java.lang.Object, java.lang.Object)
,setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
, andisReadOnly(jakarta.el.ELContext, java.lang.Object, java.lang.Object)
methods, anELResolver
is not responsible for resolving all possible (base, property) pairs. In fact, most resolvers will only handle abase
of a single type. To indicate that a resolver has successfully resolved a particular (base, property) pair, it must set thepropertyResolved
property of theELContext
totrue
. If it could not handle the given pair, it must leave this property alone. The caller must ignore the return value of the method ifpropertyResolved
isfalse
.Similarly, for the
convertToType(jakarta.el.ELContext, java.lang.Object, java.lang.Class<T>)
method anELResolver
must set thepropertyResolved
totrue
to indicate that it handles the conversion of the object to the target type.The
getFeatureDescriptors(jakarta.el.ELContext, java.lang.Object)
andgetCommonPropertyType(jakarta.el.ELContext, java.lang.Object)
methods are primarily designed for design-time tool support, but must handle invocation at runtime as well. TheBeans.isDesignTime()
method can be used to determine if the resolver is being consulted at design-time or runtime.- Since:
- Jakarta Server Pages 2.1
- See Also:
CompositeELResolver
,ELContext.getELResolver()
-
-
Field Summary
Fields Modifier and Type Field Description static String
RESOLVABLE_AT_DESIGN_TIME
The attribute name of the named attribute in theFeatureDescriptor
that specifies whether the variable or property can be resolved at runtime.static String
TYPE
The attribute name of the named attribute in theFeatureDescriptor
that specifies the runtime type of the variable or property.
-
Constructor Summary
Constructors Constructor Description ELResolver()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description <T> T
convertToType(ELContext context, Object obj, Class<T> targetType)
Converts an object to a specific type.abstract Class<?>
getCommonPropertyType(ELContext context, Object base)
Returns the most general type that this resolver accepts for theproperty
argument, given abase
object.Iterator<FeatureDescriptor>
getFeatureDescriptors(ELContext context, Object base)
Deprecated, for removal: This API element is subject to removal in a future version.This method will be removed without replacement in EL 6.0abstract Class<?>
getType(ELContext context, Object base, Object property)
For a givenbase
andproperty
, attempts to identify the most general type that is acceptable for an object to be passed as thevalue
parameter in a future call to thesetValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
method.abstract Object
getValue(ELContext context, Object base, Object property)
Attempts to resolve the givenproperty
object on the givenbase
object.Object
invoke(ELContext context, Object base, Object method, Class<?>[] paramTypes, Object[] params)
Attempts to resolve and invoke the givenmethod
on the givenbase
object.abstract boolean
isReadOnly(ELContext context, Object base, Object property)
For a givenbase
andproperty
, attempts to determine whether a call tosetValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.abstract void
setValue(ELContext context, Object base, Object property, Object value)
Attempts to set the value of the givenproperty
object on the givenbase
object.
-
-
-
Field Detail
-
TYPE
public static final String TYPE
The attribute name of the named attribute in theFeatureDescriptor
that specifies the runtime type of the variable or property.- See Also:
- Constant Field Values
-
RESOLVABLE_AT_DESIGN_TIME
public static final String RESOLVABLE_AT_DESIGN_TIME
The attribute name of the named attribute in theFeatureDescriptor
that specifies whether the variable or property can be resolved at runtime.- See Also:
- Constant Field Values
-
-
Method Detail
-
getValue
public abstract Object getValue(ELContext context, Object base, Object property)
Attempts to resolve the givenproperty
object on the givenbase
object.If this resolver handles the given (base, property) pair, the
propertyResolved
property of theELContext
object must be set totrue
by the resolver, before returning. If this property is nottrue
after this method is called, the caller should ignore the return value.- Parameters:
context
- The context of this evaluation.base
- The base object whose property value is to be returned, ornull
to resolve a top-level variable.property
- The property or variable to be resolved.- Returns:
- If the
propertyResolved
property ofELContext
was set totrue
, then the result of the variable or property resolution; otherwise undefined. - Throws:
NullPointerException
- if context isnull
PropertyNotFoundException
- if the given (base, property) pair is handled by thisELResolver
but the specified variable or property does not exist or is not readable.ELException
- if an exception was thrown while performing the property or variable resolution. The thrown exception must be included as the cause property of this exception, if available.
-
invoke
public Object invoke(ELContext context, Object base, Object method, Class<?>[] paramTypes, Object[] params)
Attempts to resolve and invoke the givenmethod
on the givenbase
object.If this resolver handles the given (base, method) pair, the
propertyResolved
property of theELContext
object must be set totrue
by the resolver, before returning. If this property is nottrue
after this method is called, the caller should ignore the return value.A default implementation is provided that returns null so that existing classes that extend ELResolver can continue to function.
- Parameters:
context
- The context of this evaluation.base
- The bean on which to invoke the methodmethod
- The simple name of the method to invoke. Will be coerced to aString
.paramTypes
- An array of Class objects identifying the method's formal parameter types, in declared order. Use an empty array if the method has no parameters. Can benull
, in which case the method's formal parameter types are assumed to be unknown.params
- The parameters to pass to the method, ornull
if no parameters.- Returns:
- The result of the method invocation (
null
if the method has avoid
return type). - Throws:
MethodNotFoundException
- if no suitable method can be found.ELException
- if an exception was thrown while performing (base, method) resolution. The thrown exception must be included as the cause property of this exception, if available. If the exception thrown is anInvocationTargetException
, extract itscause
and pass it to theELException
constructor.- Since:
- Jakarta Expression Language 2.2
-
getType
public abstract Class<?> getType(ELContext context, Object base, Object property)
For a givenbase
andproperty
, attempts to identify the most general type that is acceptable for an object to be passed as thevalue
parameter in a future call to thesetValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
method.If this resolver handles the given (base, property) pair, the
propertyResolved
property of theELContext
object must be set totrue
by the resolver, before returning. If this property is nottrue
after this method is called, the caller should ignore the return value.This is not always the same as
getValue().getClass()
. For example, in the case of anArrayELResolver
, thegetType
method will return the element type of the array, which might be a superclass of the type of the actual element that is currently in the specified array element.If the resolver or the property is read-only, this method must return
null
.- Parameters:
context
- The context of this evaluation.base
- The base object whose property value is to be analyzed, ornull
to analyze a top-level variable.property
- The property or variable to return the acceptable type for.- Returns:
- If the
propertyResolved
property ofELContext
was set totrue
, the most general acceptable type which must benull
if the either the property or the resolver is read-only; otherwise undefined - Throws:
PropertyNotFoundException
- if the given (base, property) pair is handled by thisELResolver
but the specified variable or property does not exist or is not readable.ELException
- if an exception was thrown while performing the property or variable resolution. The thrown exception must be included as the cause property of this exception, if available.
-
setValue
public abstract void setValue(ELContext context, Object base, Object property, Object value)
Attempts to set the value of the givenproperty
object on the givenbase
object.If this resolver handles the given (base, property) pair, the
propertyResolved
property of theELContext
object must be set totrue
by the resolver, before returning. If this property is nottrue
after this method is called, the caller can safely assume no value has been set.- Parameters:
context
- The context of this evaluation.base
- The base object whose property value is to be set, ornull
to set a top-level variable.property
- The property or variable to be set.value
- The value to set the property or variable to.- Throws:
NullPointerException
- if context isnull
PropertyNotFoundException
- if the given (base, property) pair is handled by thisELResolver
but the specified variable or property does not exist.PropertyNotWritableException
- if the given (base, property) pair is handled by thisELResolver
but the specified variable or property is not writable.ELException
- if an exception was thrown while attempting to set the property or variable. The thrown exception must be included as the cause property of this exception, if available.
-
isReadOnly
public abstract boolean isReadOnly(ELContext context, Object base, Object property)
For a givenbase
andproperty
, attempts to determine whether a call tosetValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.If this resolver handles the given (base, property) pair, the
propertyResolved
property of theELContext
object must be set totrue
by the resolver, before returning. If this property is nottrue
after this method is called, the caller should ignore the return value.- Parameters:
context
- The context of this evaluation.base
- The base object whose property value is to be analyzed, ornull
to analyze a top-level variable.property
- The property or variable to return the read-only status for.- Returns:
- If the
propertyResolved
property ofELContext
was set totrue
, thentrue
if the property is read-only orfalse
if not; otherwise undefined. - Throws:
NullPointerException
- if context isnull
PropertyNotFoundException
- if the given (base, property) pair is handled by thisELResolver
but the specified variable or property does not exist.ELException
- if an exception was thrown while performing the property or variable resolution. The thrown exception must be included as the cause property of this exception, if available.
-
getFeatureDescriptors
@Deprecated(forRemoval=true, since="5.0") public Iterator<FeatureDescriptor> getFeatureDescriptors(ELContext context, Object base)
Deprecated, for removal: This API element is subject to removal in a future version.This method will be removed without replacement in EL 6.0Returns information about the set of variables or properties that can be resolved for the givenbase
object. One use for this method is to assist tools in auto-completion.If the
base
parameter isnull
, the resolver must enumerate the list of top-level variables it can resolve.The
Iterator
returned must contain zero or more instances ofFeatureDescriptor
, in no guaranteed order. In the case of primitive types such asint
, the valuenull
must be returned. This is to prevent the useless iteration through all possible primitive values. A return value ofnull
indicates that this resolver does not handle the givenbase
object or that the results are too complex to represent with this method and thegetCommonPropertyType(jakarta.el.ELContext, java.lang.Object)
method should be used instead.Each
FeatureDescriptor
will contain information about a single variable or property. In addition to the standard properties, theFeatureDescriptor
must have two named attributes (as set by thesetValue
method):TYPE
- The value of this named attribute must be an instance ofjava.lang.Class
and specify the runtime type of the variable or property.RESOLVABLE_AT_DESIGN_TIME
- The value of this named attribute must be an instance ofjava.lang.Boolean
and indicates whether it is safe to attempt to resolve this property at design-time. For instance, it may be unsafe to attempt a resolution at design time if theELResolver
needs access to a resource that is only available at runtime and no acceptable simulated value can be provided.
The caller should be aware that the
Iterator
returned might iterate through a very large or even infinitely large set of properties. Care should be taken by the caller to not get stuck in an infinite loop.This is a "best-effort" list. Not all
ELResolver
s will return completely accurate results, but all must be callable at both design-time and runtime (i.e. whether or notBeans.isDesignTime()
returnstrue
), without causing errors.The
propertyResolved
property of theELContext
is not relevant to this method. The results of allELResolver
s are concatenated in the case of composite resolvers.The default implementation in
ELResolver
returnsnull
. Sub-classes may wish to over-ride this method.- Parameters:
context
- The context of this evaluation.base
- The base object whose set of valid properties is to be enumerated, ornull
to enumerate the set of top-level variables that this resolver can evaluate.- Returns:
- An
Iterator
containing zero or more (possibly infinitely more)FeatureDescriptor
objects, ornull
if this resolver does not handle the givenbase
object or that the results are too complex to represent with this method - See Also:
FeatureDescriptor
-
getCommonPropertyType
public abstract Class<?> getCommonPropertyType(ELContext context, Object base)
Returns the most general type that this resolver accepts for theproperty
argument, given abase
object. One use for this method is to assist tools in auto-completion.This assists tools in auto-completion and also provides a way to express that the resolver accepts a primitive value, such as an integer index into an array. For example, the
ArrayELResolver
will accept anyint
as aproperty
, so the return value would beInteger.class
.- Parameters:
context
- The context of this evaluation.base
- The base object to return the most general property type for, ornull
to enumerate the set of top-level variables that this resolver can evaluate.- Returns:
null
if thisELResolver
does not know how to handle the givenbase
object; otherwiseObject.class
if any type ofproperty
is accepted; otherwise the most generalproperty
type accepted for the givenbase
.
-
convertToType
public <T> T convertToType(ELContext context, Object obj, Class<T> targetType)
Converts an object to a specific type.An
ELException
is thrown if an error occurs during the conversion.- Parameters:
context
- The context of this evaluation.obj
- The object to convert.targetType
- The target type for the conversion.- Returns:
- object converted to
targetType
- Throws:
ELException
- thrown if errors occur.
-
-