Module jakarta.faces

Package com.sun.faces.el

Class ResourceELResolver

java.lang.Object

jakarta.el.ELResolver

com.sun.faces.el.ResourceELResolver

public class ResourceELResolver
extends ELResolver

ELResolver to resolve expressions like the following:

• #{resource['library:resource']}
• #{resource['resource']}

Constructor Summary

Constructors

Constructor	Description
ResourceELResolver()

Method Summary

Modifier and Type	Method	Description
Class<?>	getCommonPropertyType(ELContext context, Object base)	Returns the most general type that this resolver accepts for the property argument, given a base object.
Class<?>	getType(ELContext context, Object base, Object property)	For a given base and property, attempts to identify the most general type that is acceptable for an object to be passed as the value parameter in a future call to the ELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object) method.
Object	getValue(ELContext context, Object base, Object property)	If base and property are not null and base is an instance of ResourceHandler, perform the following: If property doesn't contain : treat property as the resource name and pass property to ResourceHandler.createResource(String) If property contains a single : treat the content before the : as the library name, and the content after the : to be the resource name and pass both to ResourceHandler.createResource(String, String) If property contains more than one : then throw a ELException If one of the above steps resulted in the creation of a Resource instance, call ELContext.setPropertyResolved(true) and return the result of Resource.getRequestPath()
boolean	isReadOnly(ELContext context, Object base, Object property)	For a given base and property, attempts to determine whether a call to ELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object) will always fail.
void	setValue(ELContext context, Object base, Object property, Object value)	This is basically a no-op.

Methods inherited from class jakarta.el.ELResolver

convertToType, invoke

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResourceELResolver

public ResourceELResolver()

Method Details

getValue

public Object getValue(ELContext context,
 Object base,
 Object property)

If base and property are not null and base is an instance of ResourceHandler, perform the following:

• If property doesn't contain : treat property as the resource name and pass property to ResourceHandler.createResource(String)
• If property contains a single : treat the content before the : as the library name, and the content after the : to be the resource name and pass both to ResourceHandler.createResource(String, String)
• If property contains more than one : then throw a ELException
• If one of the above steps resulted in the creation of a Resource instance, call ELContext.setPropertyResolved(true) and return the result of Resource.getRequestPath()

Specified by:

getValue in class ELResolver

Parameters:

context - The context of this evaluation.

base - The base object whose property value is to be returned, or null to resolve a top-level variable.

property - The property or variable to be resolved.

Returns:

If the propertyResolved property of ELContext was set to true, then the result of the variable or property resolution; otherwise undefined.

See Also:

• ELResolver.getValue(jakarta.el.ELContext, Object, Object)

getType

public Class<?> getType(ELContext context,
 Object base,
 Object property)

Description copied from class: ELResolver

For a given base and property, attempts to identify the most general type that is acceptable for an object to be passed as the value parameter in a future call to the ELResolver.setValue(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 the ELContext object must be set to true by the resolver, before returning. If this property is not true 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 an ArrayELResolver, the getType 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.

Specified by:

getType in class ELResolver

Parameters:

context - The context of this evaluation.

base - The base object whose property value is to be analyzed, or null to analyze a top-level variable.

property - The property or variable to return the acceptable type for.

Returns:

null as this resolver only performs lookups

Throws:

PropertyNotFoundException - if base and property are null

setValue

public void setValue(ELContext context,
 Object base,
 Object property,
 Object value)

This is basically a no-op.

Specified by:

setValue in class ELResolver

Parameters:

context - The context of this evaluation.

base - The base object whose property value is to be set, or null 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:

PropertyNotFoundException - if base and property are null

isReadOnly

public boolean isReadOnly(ELContext context,
 Object base,
 Object property)

Description copied from class: ELResolver

For a given base and property, attempts to determine whether a call to ELResolver.setValue(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 the ELContext object must be set to true by the resolver, before returning. If this property is not true after this method is called, the caller should ignore the return value.

Specified by:

isReadOnly in class ELResolver

Parameters:

context - The context of this evaluation.

base - The base object whose property value is to be analyzed, or null to analyze a top-level variable.

property - The property or variable to return the read-only status for.

Returns:

false (basically ignored by the EL system)

Throws:

PropertyNotFoundException - if base and property are null

getCommonPropertyType

public Class<?> getCommonPropertyType(ELContext context,
 Object base)

Description copied from class: ELResolver

Returns the most general type that this resolver accepts for the property argument, given a base 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 any int as a property, so the return value would be Integer.class.

Specified by:

getCommonPropertyType in class ELResolver

Parameters:

context - The context of this evaluation.

base - The base object to return the most general property type for, or null to enumerate the set of top-level variables that this resolver can evaluate.

Returns:

String.class - getType() expects String properties