Jakarta EE 11.0.0 · com.sun.faces.el.ResourceELResolver

Access	Constructor and Description
public	ResourceELResolver()

Method Summary

Modifier and Type	Method and Description
public Class<?>	Returns: `String.class` - getType() expects String properties getCommonPropertyType(ELContext The context of this evaluation. context, Object 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. base) Implements abstract jakarta.el.ELResolver.getCommonPropertyType. Returns the most general type that this resolver accepts for the `property` argument, given a `base` object.
public Class<?>	Returns: `null` as this resolver only performs lookups getType(ELContext The context of this evaluation. context, Object The base object whose property value is to be analyzed, or `null` to analyze a top-level variable. base, Object The property or variable to return the acceptable type for. property) Implements abstract jakarta.el.ELResolver.getType. 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 `setValue` method.
public Object	getValue(ELContext The context of this evaluation. context, Object The base object whose property value is to be returned, or `null` to resolve a top-level variable. base, Object The property or variable to be resolved. property) Implements abstract jakarta.el.ELResolver.getValue. 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 `jakarta.faces.application.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 `jakarta.faces.application.Resource#getRequestPath()`
private boolean	isPropertyValid(String property)
public boolean	Returns: `false` (basically ignored by the EL system) isReadOnly(ELContext The context of this evaluation. context, Object The base object whose property value is to be analyzed, or `null` to analyze a top-level variable. base, Object The property or variable to return the read-only status for. property) Implements abstract jakarta.el.ELResolver.isReadOnly. For a given `base` and `property`, attempts to determine whether a call to `setValue` will always fail.
public void	setValue(ELContext The context of this evaluation. context, Object The base object whose property value is to be set, or `null` to set a top-level variable. base, Object The property or variable to be set. property, Object The value to set the property or variable to. value) Implements abstract jakarta.el.ELResolver.setValue. This is basically a no-op.

Inherited from jakarta.el.ELResolver:: convertToType invoke

ResourceELResolver	back to summary
public ResourceELResolver()

Method Detail

getCommonPropertyType back to summary

getCommonPropertyType	back to summary
public Class<?> getCommonPropertyType(ELContext context, Object base) Implements abstract jakarta.el.ELResolver.getCommonPropertyType. Doc from jakarta.el.ELResolver.getCommonPropertyType. 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`. Parameters context:ELContext The context of this evaluation. base:Object 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:Class<?> `String.class` - getType() expects String properties Annotations @Override

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

Implements abstract jakarta.el.ELResolver.getCommonPropertyType.

Doc from jakarta.el.ELResolver.getCommonPropertyType.

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.

Parameters

context:ELContext: The context of this evaluation.
base:Object: 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:Class<?>

String.class - getType() expects String properties

Annotations

@Override

getType back to summary

getType	back to summary
public Class<?> getType(ELContext context, Object base, Object property) Implements abstract jakarta.el.ELResolver.getType. Doc from jakarta.el.ELResolver.getType. 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 `setValue` 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`. Parameters context:ELContext The context of this evaluation. base:Object The base object whose property value is to be analyzed, or `null` to analyze a top-level variable. property:Object The property or variable to return the acceptable type for. Returns:Class<?> `null` as this resolver only performs lookups Annotations @Override Exceptions PropertyNotFoundException: if base and property are null

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

Implements abstract jakarta.el.ELResolver.getType.

Doc from jakarta.el.ELResolver.getType.

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

Parameters

context:ELContext: The context of this evaluation.
base:Object: The base object whose property value is to be analyzed, or null to analyze a top-level variable.
property:Object: The property or variable to return the acceptable type for.

Returns:Class<?>

null as this resolver only performs lookups

Annotations

@Override

Exceptions

PropertyNotFoundException:: if base and property are null

getValue back to summary

getValue	back to summary
public Object getValue(ELContext context, Object base, Object property) Implements abstract jakarta.el.ELResolver.getValue. 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 `jakarta.faces.application.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 `jakarta.faces.application.Resource#getRequestPath()` Parameters context:ELContext Doc from jakarta.el.ELResolver.getValue. The context of this evaluation. base:Object Doc from jakarta.el.ELResolver.getValue. The base object whose property value is to be returned, or `null` to resolve a top-level variable. property:Object Doc from jakarta.el.ELResolver.getValue. The property or variable to be resolved. Returns:Object Doc from jakarta.el.ELResolver.getValue. If the `propertyResolved` property of `ELContext` was set to `true`, then the result of the variable or property resolution; otherwise undefined. Annotations @Override See Also `ELResolver#getValue(jakarta.el.ELContext, Object, Object)`

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

Implements abstract jakarta.el.ELResolver.getValue.

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 jakarta.faces.application.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 jakarta.faces.application.Resource#getRequestPath()

Parameters

context:ELContext

Doc from jakarta.el.ELResolver.getValue.

The context of this evaluation.

base:Object

Doc from jakarta.el.ELResolver.getValue.

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

property:Object

Doc from jakarta.el.ELResolver.getValue.

The property or variable to be resolved.

Returns:Object

Doc from jakarta.el.ELResolver.getValue.

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

Annotations

@Override

isPropertyValid	back to summary
private boolean isPropertyValid(String property)

isReadOnly back to summary

isReadOnly	back to summary
public boolean isReadOnly(ELContext context, Object base, Object property) Implements abstract jakarta.el.ELResolver.isReadOnly. Doc from jakarta.el.ELResolver.isReadOnly. For a given `base` and `property`, attempts to determine whether a call to `setValue` 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. Parameters context:ELContext The context of this evaluation. base:Object The base object whose property value is to be analyzed, or `null` to analyze a top-level variable. property:Object The property or variable to return the read-only status for. Returns:boolean `false` (basically ignored by the EL system) Annotations @Override Exceptions PropertyNotFoundException: if base and property are null

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

Implements abstract jakarta.el.ELResolver.isReadOnly.

Doc from jakarta.el.ELResolver.isReadOnly.

For a given base and property, attempts to determine whether a call to setValue will always fail.

Parameters

context:ELContext: The context of this evaluation.
base:Object: The base object whose property value is to be analyzed, or null to analyze a top-level variable.
property:Object: The property or variable to return the read-only status for.

Returns:boolean

false (basically ignored by the EL system)

Annotations

@Override

Exceptions

PropertyNotFoundException:: if base and property are null

setValue back to summary

setValue	back to summary
public void setValue(ELContext context, Object base, Object property, Object value) Implements abstract jakarta.el.ELResolver.setValue. This is basically a no-op. Parameters context:ELContext Doc from jakarta.el.ELResolver.setValue. The context of this evaluation. base:Object Doc from jakarta.el.ELResolver.setValue. The base object whose property value is to be set, or `null` to set a top-level variable. property:Object Doc from jakarta.el.ELResolver.setValue. The property or variable to be set. value:Object Doc from jakarta.el.ELResolver.setValue. The value to set the property or variable to. Annotations @Override Exceptions PropertyNotFoundException: if base and property are null