Jakarta Expression Language 3.0 Implementation 3.0.4 · com.sun.el.stream.StreamELResolver

Access	Constructor and Description
public	StreamELResolver()

Method Summary

Modifier and Type	Method and Description
private static Iterator<Object>	arrayIterator(final Object base)
public Class<?>	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 javax.el.ELResolver.getCommonPropertyType. Returns the most general type that this resolver accepts for the `property` argument, given a `base` object.
public Iterator<FeatureDescriptor>	getFeatureDescriptors(ELContext The context of this evaluation. context, Object The base object whose set of valid properties is to be enumerated, or `null` to enumerate the set of top-level variables that this resolver can evaluate. base) Implements abstract javax.el.ELResolver.getFeatureDescriptors. Returns information about the set of variables or properties that can be resolved for the given `base` object.
public Class<?>	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 javax.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 javax.el.ELResolver.getValue. Attempts to resolve the given `property` object on the given `base` object.
public Object	invoke(final ELContext The context of this evaluation. context, final Object The bean on which to invoke the method base, final Object The simple name of the method to invoke. Will be coerced to a `String`. method, final Class<?>[] 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 be `null`, in which case the method's formal parameter types are assumed to be unknown. paramTypes, final Object[] The parameters to pass to the method, or `null` if no parameters. params) Overrides javax.el.ELResolver.invoke. Attempts to resolve and invoke the given `method` on the given `base` object.
public boolean	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 javax.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 javax.el.ELResolver.setValue. Attempts to set the value of the given `property` object on the given `base` object.

Inherited from javax.el.ELResolver:: convertToType

StreamELResolver	back to summary
public StreamELResolver()

Method Detail

arrayIterator	back to summary
private static Iterator<Object> arrayIterator(final Object base)

getCommonPropertyType back to summary

getCommonPropertyType	back to summary
public Class<?> getCommonPropertyType(ELContext context, Object base) Implements abstract javax.el.ELResolver.getCommonPropertyType. Doc from javax.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<?> `null` if this `ELResolver` does not know how to handle the given `base` object; otherwise `Object.class` if any type of `property` is accepted; otherwise the most general `property` type accepted for the given `base`. Annotations @Override

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

Implements abstract javax.el.ELResolver.getCommonPropertyType.

Doc from javax.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<?>

null if this ELResolver does not know how to handle the given base object; otherwise Object.class if any type of property is accepted; otherwise the most general property type accepted for the given base.

Annotations

@Override

getFeatureDescriptors back to summary

getFeatureDescriptors	back to summary
public Iterator<FeatureDescriptor> getFeatureDescriptors(ELContext context, Object base) Implements abstract javax.el.ELResolver.getFeatureDescriptors. Doc from javax.el.ELResolver.getFeatureDescriptors. Returns information about the set of variables or properties that can be resolved for the given `base` object. One use for this method is to assist tools in auto-completion. If the `base` parameter is `null`, the resolver must enumerate the list of top-level variables it can resolve. The `Iterator` returned must contain zero or more instances of `java.beans.FeatureDescriptor`, in no guaranteed order. In the case of primitive types such as `int`, the value `null` must be returned. This is to prevent the useless iteration through all possible primitive values. A return value of `null` indicates that this resolver does not handle the given `base` object or that the results are too complex to represent with this method and the `getCommonPropertyType` method should be used instead. Each `FeatureDescriptor` will contain information about a single variable or property. In addition to the standard properties, the `FeatureDescriptor` must have two named attributes (as set by the `setValue` method): `TYPE` - The value of this named attribute must be an instance of `java.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 of `java.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 the `ELResolver` 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 not `Beans.isDesignTime()` returns `true`), without causing errors. The `propertyResolved` property of the `ELContext` is not relevant to this method. The results of all `ELResolver`s are concatenated in the case of composite resolvers. Parameters context:ELContext The context of this evaluation. base:Object The base object whose set of valid properties is to be enumerated, or `null` to enumerate the set of top-level variables that this resolver can evaluate. Returns:Iterator<FeatureDescriptor> An `Iterator` containing zero or more (possibly infinitely more) `FeatureDescriptor` objects, or `null` if this resolver does not handle the given `base` object or that the results are too complex to represent with this method Annotations @Override

public Iterator<FeatureDescriptor> getFeatureDescriptors(ELContext context, Object base)

Implements abstract javax.el.ELResolver.getFeatureDescriptors.

Doc from javax.el.ELResolver.getFeatureDescriptors.

Returns information about the set of variables or properties that can be resolved for the given base object. One use for this method is to assist tools in auto-completion.

If the base parameter is null, the resolver must enumerate the list of top-level variables it can resolve.

The Iterator returned must contain zero or more instances of java.beans.FeatureDescriptor, in no guaranteed order. In the case of primitive types such as int, the value null must be returned. This is to prevent the useless iteration through all possible primitive values. A return value of null indicates that this resolver does not handle the given base object or that the results are too complex to represent with this method and the getCommonPropertyType method should be used instead.

Each FeatureDescriptor will contain information about a single variable or property. In addition to the standard properties, the FeatureDescriptor must have two named attributes (as set by the setValue method):

TYPE - The value of this named attribute must be an instance of java.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 of java.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 the ELResolver 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 ELResolvers will return completely accurate results, but all must be callable at both design-time and runtime (i.e. whether or not Beans.isDesignTime() returns true), without causing errors.

The propertyResolved property of the ELContext is not relevant to this method. The results of all ELResolvers are concatenated in the case of composite resolvers.

Parameters

context:ELContext: The context of this evaluation.
base:Object: The base object whose set of valid properties is to be enumerated, or null to enumerate the set of top-level variables that this resolver can evaluate.

Returns:Iterator<FeatureDescriptor>

An Iterator containing zero or more (possibly infinitely more) FeatureDescriptor objects, or null if this resolver does not handle the given base object or that the results are too complex to represent with this method

Annotations

@Override

getType back to summary

getType	back to summary
public Class<?> getType(ELContext context, Object base, Object property) Implements abstract javax.el.ELResolver.getType. Doc from javax.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. 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<?> If the `propertyResolved` property of `ELContext` was set to `true`, then the most general acceptable type; otherwise undefined. Annotations @Override

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

Implements abstract javax.el.ELResolver.getType.

Doc from javax.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.

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<?>

If the propertyResolved property of ELContext was set to true, then the most general acceptable type; otherwise undefined.

Annotations

@Override

getValue back to summary

getValue	back to summary
public Object getValue(ELContext context, Object base, Object property) Implements abstract javax.el.ELResolver.getValue. Doc from javax.el.ELResolver.getValue. Attempts to resolve the given `property` object on the given `base` object. 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 returned, or `null` to resolve a top-level variable. property:Object The property or variable to be resolved. Returns:Object If the `propertyResolved` property of `ELContext` was set to `true`, then the result of the variable or property resolution; otherwise undefined. Annotations @Override

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

Implements abstract javax.el.ELResolver.getValue.

Doc from javax.el.ELResolver.getValue.

Attempts to resolve the given property object on the given base object.

Parameters

context:ELContext: The context of this evaluation.
base:Object: The base object whose property value is to be returned, or null to resolve a top-level variable.
property:Object: The property or variable to be resolved.

Returns:Object

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

Annotations

@Override

invoke back to summary

invoke	back to summary
public Object invoke(final ELContext context, final Object base, final Object method, final Class<?>[] paramTypes, final Object[] params) Overrides javax.el.ELResolver.invoke. Doc from javax.el.ELResolver.invoke. Attempts to resolve and invoke the given `method` on the given `base` object. If this resolver handles the given (base, method) 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. A default implementation is provided that returns null so that existing classes that extend ELResolver can continue to function. Parameters context:ELContext The context of this evaluation. base:Object The bean on which to invoke the method method:Object The simple name of the method to invoke. Will be coerced to a `String`. paramTypes:Class<?>[] 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 be `null`, in which case the method's formal parameter types are assumed to be unknown. 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). Annotations @Override

public Object invoke(final ELContext context, final Object base, final Object method, final Class<?>[] paramTypes, final Object[] params)

Overrides javax.el.ELResolver.invoke.

Doc from javax.el.ELResolver.invoke.

Attempts to resolve and invoke the given method on the given base object.

If this resolver handles the given (base, method) 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.

A default implementation is provided that returns null so that existing classes that extend ELResolver can continue to function.

Parameters

context:ELContext: The context of this evaluation.
base:Object: The bean on which to invoke the method
method:Object: The simple name of the method to invoke. Will be coerced to a String.
paramTypes:Class<?>[]: 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 be null, in which case the method's formal parameter types are assumed to be unknown.
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).

Annotations

@Override

isReadOnly back to summary

isReadOnly	back to summary
public boolean isReadOnly(ELContext context, Object base, Object property) Implements abstract javax.el.ELResolver.isReadOnly. Doc from javax.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 If the `propertyResolved` property of `ELContext` was set to `true`, then `true` if the property is read-only or `false` if not; otherwise undefined. Annotations @Override

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

Implements abstract javax.el.ELResolver.isReadOnly.

Doc from javax.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

If the propertyResolved property of ELContext was set to true, then true if the property is read-only or false if not; otherwise undefined.

Annotations

@Override

setValue back to summary

setValue	back to summary
public void setValue(ELContext context, Object base, Object property, Object value) Implements abstract javax.el.ELResolver.setValue. Doc from javax.el.ELResolver.setValue. Attempts to set the value of the given `property` object on the given `base` object. 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 can safely assume no value has been set. Parameters context:ELContext The context of this evaluation. base:Object The base object whose property value is to be set, or `null` to set a top-level variable. property:Object The property or variable to be set. value:Object The value to set the property or variable to. Annotations @Override

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

Implements abstract javax.el.ELResolver.setValue.

Doc from javax.el.ELResolver.setValue.

Attempts to set the value of the given property object on the given base object.

Parameters

context:ELContext: The context of this evaluation.
base:Object: The base object whose property value is to be set, or null to set a top-level variable.
property:Object: The property or variable to be set.
value:Object: The value to set the property or variable to.

Annotations

@Override

public Class StreamELResolver

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail