Class ResourceBundleELResolver
ResourceBundle
.
This resolver handles base objects of type java.util.ResourceBundle
. It accepts any object as a property
and coerces it to a java.lang.String
for invoking
ResourceBundle.getObject(java.lang.String)
.
This resolver is read only and will throw a PropertyNotWritableException
if setValue
is called.
ELResolver
s are combined together using CompositeELResolver
s, to define rich semantics for
evaluating an expression. See the javadocs for ELResolver
for details.
- Since:
- Jakarta Server Pages 2.1
- See Also:
-
Field Summary
Fields inherited from class jakarta.el.ELResolver
RESOLVABLE_AT_DESIGN_TIME, TYPE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionClass<?>
getCommonPropertyType
(ELContext context, Object base) If the base object is a ResourceBundle, returns the most general type that this resolver accepts for theproperty
argument.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.0Class<?>
If the base object is an instance ofResourceBundle
, returnnull
, since the resolver is read only.If the base object is an instance ofResourceBundle
, the provided property will first be coerced to aString
.boolean
isReadOnly
(ELContext context, Object base, Object property) void
If the base object is a ResourceBundle, throw aPropertyNotWritableException
.Methods inherited from class jakarta.el.ELResolver
convertToType, invoke
-
Constructor Details
-
ResourceBundleELResolver
public ResourceBundleELResolver()
-
-
Method Details
-
getValue
If the base object is an instance ofResourceBundle
, the provided property will first be coerced to aString
. TheObject
returned bygetObject
on the baseResourceBundle
will be returned.If the base is
ResourceBundle
, thepropertyResolved
property of theELContext
object must be set totrue
by this resolver, before returning. If this property is nottrue
after this method is called, the caller should ignore the return value.- Specified by:
getValue
in classELResolver
- Parameters:
context
- The context of this evaluation.base
- The ResourceBundle to analyze.property
- The name of the property to analyze. Will be coerced to aString
.- Returns:
- If the
propertyResolved
property ofELContext
was set totrue
, thennull
if property isnull
; otherwise theObject
for the given key (property coerced toString
) from theResourceBundle
. If no object for the given key can be found, then theString
"???" + key + "???". - Throws:
NullPointerException
- if context isnull
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.
-
getType
If the base object is an instance ofResourceBundle
, returnnull
, since the resolver is read only.If the base is
ResourceBundle
, thepropertyResolved
property of theELContext
object must be set totrue
by this resolver, before returning. If this property is nottrue
after this method is called, the caller should ignore the return value.- Specified by:
getType
in classELResolver
- Parameters:
context
- The context of this evaluation.base
- The ResourceBundle to analyze.property
- The name of the property to analyze.- Returns:
- If the
propertyResolved
property ofELContext
was set totrue
, thennull
; otherwise undefined. - Throws:
NullPointerException
- if context isnull
-
setValue
If the base object is a ResourceBundle, throw aPropertyNotWritableException
.- Specified by:
setValue
in classELResolver
- Parameters:
context
- The context of this evaluation.base
- The ResourceBundle to be modified. Only bases that are of type ResourceBundle are handled.property
- The String property to use.value
- The value to be set.- Throws:
NullPointerException
- if context isnull
.PropertyNotWritableException
- Always thrown if base is an instance of ReasourceBundle.
-
isReadOnly
- Specified by:
isReadOnly
in classELResolver
- Parameters:
context
- The context of this evaluation.base
- The ResourceBundle to be modified. Only bases that are of type ResourceBundle are handled.property
- The String property to use.- Returns:
- If the
propertyResolved
property ofELContext
was set totrue
, thentrue
; otherwise undefined. - Throws:
NullPointerException
- if context isnull
-
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.0If the base object is a ResourceBundle, returns anIterator
containing the set of keys available in theResourceBundle
. Otherwise, returnsnull
.The
Iterator
returned must contain zero or more instances ofFeatureDescriptor
. Each info object contains information about a key in the ResourceBundle, and is initialized as follows:- displayName - The
String
key - name - Same as displayName property.
- shortDescription - Empty string
- expert -
false
- hidden -
false
- preferred -
true
FeatureDescriptor
s:ELResolver.TYPE
-String.class
ELResolver.RESOLVABLE_AT_DESIGN_TIME
-true
- Overrides:
getFeatureDescriptors
in classELResolver
- Parameters:
context
- The context of this evaluation.base
- The bundle whose keys are to be iterated over. Only bases of typeResourceBundle
are handled by this resolver.- Returns:
- An
Iterator
containing zero or more (possibly infinitely more)FeatureDescriptor
objects, each representing a key in this bundle, ornull
if the base object is not a ResourceBundle. - See Also:
- displayName - The
-
getCommonPropertyType
If the base object is a ResourceBundle, returns the most general type that this resolver accepts for theproperty
argument. Otherwise, returnsnull
.Assuming the base is a
ResourceBundle
, this method will always returnString.class
.- Specified by:
getCommonPropertyType
in classELResolver
- Parameters:
context
- The context of this evaluation.base
- The bundle to analyze. Only bases of typeResourceBundle
are handled by this resolver.- Returns:
null
if base is not aResourceBundle
; otherwiseString.class
.
-