Jakarta EE 11.0.0 · jakarta.el.ArrayELResolver · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	isReadOnly
private static final String	LENGTH_PROPERTY_NAME

Access	Constructor and Description
public	ArrayELResolver() Creates a new read/write `ArrayELResolver`.
public	ArrayELResolver(boolean `true` if this resolver cannot modify arrays; `false` otherwise. isReadOnly) Creates a new `ArrayELResolver` whose read-only status is determined by the given parameter.

Method Summary

Modifier and Type	Method and Description
public Class<?>	Returns: `null` if base is not a Java language array; otherwise `Integer.class`. getCommonPropertyType(ELContext The context of this evaluation. context, Object The array to analyze. Only bases that are a Java language array are handled by this resolver. base) Implements abstract jakarta.el.ELResolver.getCommonPropertyType. If the base object is a Java language array, returns the most general type that this resolver accepts for the `property` argument.
public Class<?>	Returns: If the `propertyResolved` property of `ELContext` was set to `true`, then the most general acceptable type which must be `null` if the either the property or the resolver is read-only; otherwise undefined getType(ELContext The context of this evaluation. context, Object The array to analyze. Only bases that are Java language arrays are handled by this resolver. base, Object The case sensitive string `"length"` or the index of the element in the array to return the acceptable type for. If not the case sensitive string `"length"`, will be coerced into an integer and checked if it is a valid index for the array, but otherwise ignored by this resolver. property) Implements abstract jakarta.el.ELResolver.getType. If the base object is an array, returns the most general acceptable type for a value in this array.
public Object	Returns: If the `propertyResolved` property of `ELContext` was set to `true`, then the length of the array, the value at the given index or `null` if the index was out of bounds. Otherwise, undefined. getValue(ELContext The context of this evaluation. context, Object The array to analyze. Only bases that are Java language arrays are handled by this resolver. base, Object Either the string `"length"` or the index of the value to be returned. An index value will be coerced into an integer. property) Implements abstract jakarta.el.ELResolver.getValue. If the base object is a Java language array, returns the length of the array or the value at the given index.
public boolean	Returns: If the `propertyResolved` property of `ELContext` was set to `true`, then `true` if calling the `setValue` method will always fail or `false` if it is possible that such a call may succeed; otherwise undefined. isReadOnly(ELContext The context of this evaluation. context, Object The array to analyze. Only bases that are a Java language array are handled by this resolver. base, Object The case sensitive string `length` or an object to coerce to an integer to provide the index to check if an attempt to call `setValue` with that index will always fail. property) Implements abstract jakarta.el.ELResolver.isReadOnly. If the base object is a Java language array, returns whether a call to `setValue` will always fail.
public void	setValue(ELContext The context of this evaluation. context, Object The array to be modified. Only bases that are Java language arrays are handled by this resolver. base, Object The case sensitive string `length` or an object to coerce to an integer to provide the index of the value to be set. property, Object The value to be set at the given index. val) Implements abstract jakarta.el.ELResolver.setValue. If the base object is a Java language array and the property is not the case sensitive string `length`, attempts to set the value at the given index with the given value.
private int	toInteger(Object p)

Inherited from jakarta.el.ELResolver:: convertToType invoke

isReadOnly	back to summary
private boolean isReadOnly

LENGTH_PROPERTY_NAME	back to summary
private static final String LENGTH_PROPERTY_NAME

ArrayELResolver	back to summary
public ArrayELResolver() Creates a new read/write `ArrayELResolver`.

ArrayELResolver	back to summary
public ArrayELResolver(boolean isReadOnly) Creates a new `ArrayELResolver` whose read-only status is determined by the given parameter. Parameters isReadOnly:boolean `true` if this resolver cannot modify arrays; `false` otherwise.

Method Detail

getCommonPropertyType back to summary

getCommonPropertyType	back to summary
public Class<?> getCommonPropertyType(ELContext context, Object base) Implements abstract jakarta.el.ELResolver.getCommonPropertyType. If the base object is a Java language array, returns the most general type that this resolver accepts for the `property` argument. Otherwise, returns `null`. Assuming the base is an array, this method will always return `Integer.class`. This is because arrays accept integers for their index. Parameters context:ELContext The context of this evaluation. base:Object The array to analyze. Only bases that are a Java language array are handled by this resolver. Returns:Class<?> `null` if base is not a Java language array; otherwise `Integer.class`. Annotations @Override

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

Implements abstract jakarta.el.ELResolver.getCommonPropertyType.

If the base object is a Java language array, returns the most general type that this resolver accepts for the property argument. Otherwise, returns null.

Assuming the base is an array, this method will always return Integer.class. This is because arrays accept integers for their index.

Parameters

context:ELContext: The context of this evaluation.
base:Object: The array to analyze. Only bases that are a Java language array are handled by this resolver.

Returns:Class<?>

null if base is not a Java language array; otherwise Integer.class.

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. If the base object is an array, returns the most general acceptable type for a value in this array. If the base is a `array`, the `propertyResolved` property of the `ELContext` object must be set to `true` by this resolver, before returning. If this property is not `true` after this method is called, the caller should ignore the return value. Assuming the base is an `array`, that this resolver was not constructed in read-only mode, and that the provided property can be coerced to a valid index for base array, this method will return `base.getClass().getComponentType()`, which is the most general type of component that can be stored at any given index in the array. Parameters context:ELContext The context of this evaluation. base:Object The array to analyze. Only bases that are Java language arrays are handled by this resolver. property:Object The case sensitive string `"length"` or the index of the element in the array to return the acceptable type for. If not the case sensitive string `"length"`, will be coerced into an integer and checked if it is a valid index for the array, but otherwise ignored by this resolver. Returns:Class<?> If the `propertyResolved` property of `ELContext` was set to `true`, then the most general acceptable type which must be `null` if the either the property or the resolver is read-only; otherwise undefined Annotations @Override Exceptions PropertyNotFoundException: if the given index is out of bounds for this array. NullPointerException: if context is `null` 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.

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

Implements abstract jakarta.el.ELResolver.getType.

If the base object is an array, returns the most general acceptable type for a value in this array.

If the base is a array, the propertyResolved property of the ELContext object must be set to true by this resolver, before returning. If this property is not true after this method is called, the caller should ignore the return value.

Assuming the base is an array, that this resolver was not constructed in read-only mode, and that the provided property can be coerced to a valid index for base array, this method will return base.getClass().getComponentType(), which is the most general type of component that can be stored at any given index in the array.

Parameters

context:ELContext: The context of this evaluation.
base:Object: The array to analyze. Only bases that are Java language arrays are handled by this resolver.
property:Object: The case sensitive string "length" or the index of the element in the array to return the acceptable type for. If not the case sensitive string "length", will be coerced into an integer and checked if it is a valid index for the array, but otherwise ignored by this resolver.

Returns:Class<?>

If the propertyResolved property of ELContext was set to true, then the most general acceptable type which must be null if the either the property or the resolver is read-only; otherwise undefined

Annotations

@Override

Exceptions

PropertyNotFoundException:: if the given index is out of bounds for this array.
NullPointerException:: if context is null
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.

getValue back to summary

getValue	back to summary
public Object getValue(ELContext context, Object base, Object property) Implements abstract jakarta.el.ELResolver.getValue. If the base object is a Java language array, returns the length of the array or the value at the given index. If the `property` argument is the case sensitive string `"length"`, then the length of the array is returned. Otherwise, the `property` argument is coerced into an integer and used as the index of the value to be returned. If the coercion could not be performed, an `IllegalArgumentException` is thrown. If the index is out of bounds, `null` is returned. If the base is a Java language array, the `propertyResolved` property of the `ELContext` object must be set to `true` by this 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 array to analyze. Only bases that are Java language arrays are handled by this resolver. property:Object Either the string `"length"` or the index of the value to be returned. An index value will be coerced into an integer. Returns:Object If the `propertyResolved` property of `ELContext` was set to `true`, then the length of the array, the value at the given index or `null` if the index was out of bounds. Otherwise, undefined. Annotations @Override Exceptions IllegalArgumentException: if the property was not the string `"length"` and could not be coerced into an integer. NullPointerException: if context is `null`. 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.

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

Implements abstract jakarta.el.ELResolver.getValue.

If the base object is a Java language array, returns the length of the array or the value at the given index. If the property argument is the case sensitive string "length", then the length of the array is returned. Otherwise, the property argument is coerced into an integer and used as the index of the value to be returned. If the coercion could not be performed, an IllegalArgumentException is thrown. If the index is out of bounds, null is returned.

If the base is a Java language array, the propertyResolved property of the ELContext object must be set to true by this 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 array to analyze. Only bases that are Java language arrays are handled by this resolver.
property:Object: Either the string "length" or the index of the value to be returned. An index value will be coerced into an integer.

Returns:Object

If the propertyResolved property of ELContext was set to true, then the length of the array, the value at the given index or null if the index was out of bounds. Otherwise, undefined.

Annotations

@Override

Exceptions

IllegalArgumentException:: if the property was not the string "length" and could not be coerced into an integer.
NullPointerException:: if context is null.
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.

isReadOnly back to summary

isReadOnly	back to summary
public boolean isReadOnly(ELContext context, Object base, Object property) Implements abstract jakarta.el.ELResolver.isReadOnly. If the base object is a Java language array, returns whether a call to `setValue` will always fail. If the base is a Java language array, the `propertyResolved` property of the `ELContext` object must be set to `true` by this resolver, before returning. If this property is not `true` after this method is called, the caller should ignore the return value. If this resolver was constructed in read-only mode or the property is the case sensitive string `length`, this method will always return `true`. Otherwise, it returns `false`. Parameters context:ELContext The context of this evaluation. base:Object The array to analyze. Only bases that are a Java language array are handled by this resolver. property:Object The case sensitive string `length` or an object to coerce to an integer to provide the index to check if an attempt to call `setValue` with that index will always fail. Returns:boolean If the `propertyResolved` property of `ELContext` was set to `true`, then `true` if calling the `setValue` method will always fail or `false` if it is possible that such a call may succeed; otherwise undefined. Annotations @Override Exceptions PropertyNotFoundException: if the given index is out of bounds for this array. NullPointerException: if context is `null` 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.

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

Implements abstract jakarta.el.ELResolver.isReadOnly.

If the base object is a Java language array, returns whether a call to setValue will always fail.

If this resolver was constructed in read-only mode or the property is the case sensitive string length, this method will always return true. Otherwise, it returns false.

Parameters

context:ELContext: The context of this evaluation.
base:Object: The array to analyze. Only bases that are a Java language array are handled by this resolver.
property:Object: The case sensitive string length or an object to coerce to an integer to provide the index to check if an attempt to call setValue with that index will always fail.

Returns:boolean

If the propertyResolved property of ELContext was set to true, then true if calling the setValue method will always fail or false if it is possible that such a call may succeed; otherwise undefined.

Annotations

@Override

Exceptions

PropertyNotFoundException:: if the given index is out of bounds for this array.
NullPointerException:: if context is null
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 back to summary

setValue	back to summary
public void setValue(ELContext context, Object base, Object property, Object val) Implements abstract jakarta.el.ELResolver.setValue. If the base object is a Java language array and the property is not the case sensitive string `length`, attempts to set the value at the given index with the given value. The index is specified by the `property` argument, and coerced into an integer. If the coercion could not be performed, an `IllegalArgumentException` is thrown. If the index is out of bounds, a `PropertyNotFoundException` is thrown. If the base is a Java language array, the `propertyResolved` property of the `ELContext` object must be set to `true` by this resolver, before returning. If this property is not `true` after this method is called, the caller can safely assume no value was set. If this resolver was constructed in read-only mode or the property is the case sensitive string `length`, this method will always throw `PropertyNotWritableException`. Parameters context:ELContext The context of this evaluation. base:Object The array to be modified. Only bases that are Java language arrays are handled by this resolver. property:Object The case sensitive string `length` or an object to coerce to an integer to provide the index of the value to be set. val:Object The value to be set at the given index. Annotations @Override Exceptions ClassCastException: if the class of the specified element prevents it from being added to this array. NullPointerException: if context is `null`. IllegalArgumentException: if the property could not be coerced into an integer, or if some aspect of the specified element prevents it from being added to this array. PropertyNotWritableException: if this resolver was constructed in read-only mode or the property was the case sensitive string `length`. PropertyNotFoundException: if the given index is out of bounds for this array. 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.

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

Implements abstract jakarta.el.ELResolver.setValue.

If the base object is a Java language array and the property is not the case sensitive string length, attempts to set the value at the given index with the given value. The index is specified by the property argument, and coerced into an integer. If the coercion could not be performed, an IllegalArgumentException is thrown. If the index is out of bounds, a PropertyNotFoundException is thrown.

If this resolver was constructed in read-only mode or the property is the case sensitive string length, this method will always throw PropertyNotWritableException.

Parameters

context:ELContext: The context of this evaluation.
base:Object: The array to be modified. Only bases that are Java language arrays are handled by this resolver.
property:Object: The case sensitive string length or an object to coerce to an integer to provide the index of the value to be set.
val:Object: The value to be set at the given index.

Annotations

@Override

Exceptions

ClassCastException:: if the class of the specified element prevents it from being added to this array.
NullPointerException:: if context is null.
IllegalArgumentException:: if the property could not be coerced into an integer, or if some aspect of the specified element prevents it from being added to this array.
PropertyNotWritableException:: if this resolver was constructed in read-only mode or the property was the case sensitive string length.
PropertyNotFoundException:: if the given index is out of bounds for this array.
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.

toInteger	back to summary
private int toInteger(Object p)

public Class ArrayELResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail