ScopedAttributeELResolver

java.lang.Object
- ELResolver
- - jakarta.servlet.jsp.el.ScopedAttributeELResolver

```
public class ScopedAttributeELResolver
extends ELResolver
```
Defines variable resolution behavior for scoped attributes.
This resolver handles all variable resolutions (where base is null. It searches PageContext.findAttribute() for a matching attribute. If not found, it will return null, or in the case of setValue it will create a new attribute in the page scope with the given name.

Since:

JSP 2.1

See Also:

jakarta.el.ELResolver

Constructor Summary

Constructors
Constructor and Description

ScopedAttributeELResolver()

Constructors
Constructor and Description
`ScopedAttributeELResolver()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Class<java.lang.String>`	`getCommonPropertyType(ELContext context, java.lang.Object base)` If the base object is `null`, returns `String.class`.
`java.util.Iterator<java.beans.FeatureDescriptor>`	`getFeatureDescriptors(ELContext context, java.lang.Object base)` If the base object is `null`, returns an `Iterator` containing `FeatureDescriptor` objects with information about each scoped attribute resolved by this resolver.
`java.lang.Class<java.lang.Object>`	`getType(ELContext context, java.lang.Object base, java.lang.Object property)` If the base object is `null`, returns `Object.class` to indicate that any type is valid to set for a scoped attribute.
`java.lang.Object`	`getValue(ELContext context, java.lang.Object base, java.lang.Object property)` If the base object is `null`, searches the page, request, session and application scopes for an attribute with the given name and returns it, or `null` if no attribute exists with the current name.
`boolean`	`isReadOnly(ELContext context, java.lang.Object base, java.lang.Object property)` If the base object is `null`, returns `false` to indicate that scoped attributes are never read-only.
`void`	`setValue(ELContext context, java.lang.Object base, java.lang.Object property, java.lang.Object val)` If the base object is `null`, sets an existing scoped attribute to the new value, or creates a new scoped attribute if one does not exist by this name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScopedAttributeELResolver
```
public ScopedAttributeELResolver()
```
- Method Detail
  - getValue
```
public java.lang.Object getValue(ELContext context,
                                 java.lang.Object base,
                                 java.lang.Object property)
```
    If the base object is null, searches the page, request, session and application scopes for an attribute with the given name and returns it, or null if no attribute exists with the current name.
    The propertyResolved property of the ELContext object must be set to true by this resolver before returning if base is null. If this property is not true after this method is called, the caller should ignore the return value.
    
    Parameters:
    
    context - The context of this evaluation.
    
    base - Only null is handled by this resolver. Other values will result in an immediate return.
    
    property - The name of the scoped attribute to resolve.
    
    Returns:
    
    If the propertyResolved property of ELContext was set to true, then the scoped attribute; otherwise undefined.
    
    Throws:
    
    java.lang.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.
  - getType
```
public java.lang.Class<java.lang.Object> getType(ELContext context,
                                                 java.lang.Object base,
                                                 java.lang.Object property)
```
    If the base object is null, returns Object.class to indicate that any type is valid to set for a scoped attribute.
    The propertyResolved property of the ELContext object must be set to true by this resolver before returning if base is null. If this property is not true after this method is called, the caller should ignore the return value.
    
    Parameters:
    
    context - The context of this evaluation.
    
    base - Only null is handled by this resolver. Other values will result in an immediate return.
    
    property - The name of the scoped attribute to resolve.
    
    Returns:
    
    If the propertyResolved property of ELContext was set to true, then Object.class; otherwise undefined.
    
    Throws:
    
    java.lang.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
```
public void setValue(ELContext context,
                     java.lang.Object base,
                     java.lang.Object property,
                     java.lang.Object val)
```
    If the base object is null, sets an existing scoped attribute to the new value, or creates a new scoped attribute if one does not exist by this name.
    If the provided attribute name matches the key of an attribute in page scope, request scope, session scope, or application scope, the corresponding attribute value will be replaced by the provided value. Otherwise, a new page scope attribute will be created with the given name and value.
    
    The propertyResolved property of the ELContext object must be set to true by this resolver before returning if base is null. If this property is not true after this method is called, the caller should ignore the return value.
    
    Parameters:
    
    context - The context of this evaluation.
    
    base - Only null is handled by this resolver. Other values will result in an immediate return.
    
    property - The name of the scoped attribute to set.
    
    val - The value for the scoped attribute.
    
    Throws:
    
    java.lang.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
```
public boolean isReadOnly(ELContext context,
                          java.lang.Object base,
                          java.lang.Object property)
```
    If the base object is null, returns false to indicate that scoped attributes are never read-only.
    The propertyResolved property of the ELContext object must be set to true by this resolver before returning if base is null. If this property is not true after this method is called, the caller should ignore the return value.
    
    Parameters:
    
    context - The context of this evaluation.
    
    base - Only null is handled by this resolver. Other values will result in an immediate return.
    
    property - The name of the scoped attribute.
    
    Returns:
    
    If the propertyResolved property of ELContext was set to true, then false; otherwise undefined.
    
    Throws:
    
    java.lang.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.
  - getFeatureDescriptors
```
public java.util.Iterator<java.beans.FeatureDescriptor> getFeatureDescriptors(ELContext context,
                                                                              java.lang.Object base)
```
    If the base object is null, returns an Iterator containing FeatureDescriptor objects with information about each scoped attribute resolved by this resolver. Otherwise, returns null.
    The Iterator returned must contain one instance of FeatureDescriptor for each scoped attribute found in any scope. Each info object contains information about a single scoped attribute, and is initialized as follows:
    
    displayName
    - The name of the scoped attribute.
    
    name
    - Same as displayName property.
    
    shortDescription
    - A suitable description for the scoped attribute. Should include the attribute's current scope (page, request, session, application). Will vary by implementation.
    
    expert
    - false
    
    hidden
    - false
    
    preferred
    - true
    
    In addition, the following named attributes must be set in the returned FeatureDescriptors:
    
    ELResolver#TYPE
    - The current runtime type of the scoped attribute.
    
    ELResolver#RESOLVABLE_AT_DESIGN_TIME
    - true.
    
    Parameters:
    
    context - The context of this evaluation.
    
    base - Only null is handled by this resolver. Other values will result in a null return value.
    
    Returns:
    
    An Iterator containing one FeatureDescriptor object for each scoped attribute, or null if base is not null.
  - getCommonPropertyType
```
public java.lang.Class<java.lang.String> getCommonPropertyType(ELContext context,
                                                               java.lang.Object base)
```
    If the base object is null, returns String.class. Otherwise, returns null.
    
    Parameters:
    
    context - The context of this evaluation.
    
    base - Only null is handled by this resolver. Other values will result in a null return value.
    
    Returns:
    
    null if base is not null; otherwise String.class.

Class ScopedAttributeELResolver

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScopedAttributeELResolver

Method Detail

getValue

getType

setValue

isReadOnly

getFeatureDescriptors

getCommonPropertyType