Top Description Inners Fields Constructors Methods
com.sun.faces.el

public Class CompositeComponentAttributesELResolver

extends ELResolver
Class Inheritance
Static Imports
com.sun.faces.component.CompositeComponentStackManager.StackType.Evaluation, .CompositeComponentStackManager.StackType.TreeCreation, com.sun.faces.util.Util.notNull

This ELResolver will handle the resolution of attrs when processing a composite component instance.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
CompositeComponentAttributesELResolver.ExpressionEvalMap

Simple Map implementation to evaluate any ValueExpression stored directly within the provided attributes map.

Field Summary

Modifier and TypeField and Description
private static final String
COMPOSITE_COMPONENT_ATTRIBUTES_NAME

Implicit object related only to the cc implicitObject.

private static final String
COMPOSITE_COMPONENT_PARENT_NAME

Implicit object related only to the cc implicit object and refers to the composite component parent (if any).

private static final String
EVAL_MAP_KEY

Key to which we store the mappings between composite component instances and their ExpressionEvalMap.

Constructor Summary

AccessConstructor and Description
public
CompositeComponentAttributesELResolver()

Method Summary

Modifier and TypeMethod and Description
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 jakarta.el.ELResolver.getCommonPropertyType.

attrs is considered a String property.

public Map<String, Object>

Returns:

an ExpressionEvalMap for the specified component
getEvalMapFor(UIComponent
the owning UIComponent
c, FacesContext
the FacesContext for the current request
ctx)

Creates (if necessary) and caches an ExpressionEvalMap instance associated with the owning UIComponent

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 jakarta.el.ELResolver.getType.

Readonly, so return null.

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 is a composite component and property is attrs, return a new ExpressionEvalMap which wraps the composite component's attributes map.

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 jakarta.el.ELResolver.isReadOnly.

Readonly, so return true

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 a no-op.

Inherited from jakarta.el.ELResolver:
convertToTypeinvoke

Field Detail

COMPOSITE_COMPONENT_ATTRIBUTES_NAMEback to summary
private static final String COMPOSITE_COMPONENT_ATTRIBUTES_NAME

Implicit object related only to the cc implicitObject.

COMPOSITE_COMPONENT_PARENT_NAMEback to summary
private static final String COMPOSITE_COMPONENT_PARENT_NAME

Implicit object related only to the cc implicit object and refers to the composite component parent (if any).

EVAL_MAP_KEYback to summary
private static final String EVAL_MAP_KEY

Key to which we store the mappings between composite component instances and their ExpressionEvalMap.

Constructor Detail

CompositeComponentAttributesELResolverback to summary
public CompositeComponentAttributesELResolver()

Method Detail

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

Implements abstract jakarta.el.ELResolver.getCommonPropertyType.

attrs is considered a String property.

Parameters
context:ELContext

Doc from jakarta.el.ELResolver.getCommonPropertyType.

The context of this evaluation.

base:Object

Doc from jakarta.el.ELResolver.getCommonPropertyType.

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

Doc from jakarta.el.ELResolver.getCommonPropertyType.

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
See Also
jakarta.el.ELResolver#getCommonPropertyType(jakarta.el.ELContext, Object)
getEvalMapForback to summary
public Map<String, Object> getEvalMapFor(UIComponent c, FacesContext ctx)

Creates (if necessary) and caches an ExpressionEvalMap instance associated with the owning UIComponent

Parameters
c:UIComponent

the owning UIComponent

ctx:FacesContext

the FacesContext for the current request

Returns:Map<String, Object>

an ExpressionEvalMap for the specified component

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

Implements abstract jakarta.el.ELResolver.getType.

Readonly, so return null.

Parameters
context:ELContext

Doc from jakarta.el.ELResolver.getType.

The context of this evaluation.

base:Object

Doc from jakarta.el.ELResolver.getType.

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

property:Object

Doc from jakarta.el.ELResolver.getType.

The property or variable to return the acceptable type for.

Returns:Class<?>

Doc from jakarta.el.ELResolver.getType.

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

Annotations
@Override
See Also
ELResolver#getType(jakarta.el.ELContext, Object, Object)
getValueback to summary
public Object getValue(ELContext context, Object base, Object property)

Implements abstract jakarta.el.ELResolver.getValue.

If base is a composite component and property is attrs, return a new ExpressionEvalMap which wraps the composite component's attributes map.

The ExpressionEvalMap simple evaluates any ValueExpression instances stored in the composite component's attribute map and returns the result.

If base is a composite component and property is parent attempt to resolve the composite componet parent of the current composite component by calling UIComponent#getCompositeComponentParent(jakarta.faces.component.UIComponent)) and returning that value.

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
jakarta.el.ELResolver#getValue(jakarta.el.ELContext, Object, Object), com.sun.faces.el.CompositeComponentAttributesELResolver.ExpressionEvalMap
isReadOnlyback to summary
public boolean isReadOnly(ELContext context, Object base, Object property)

Implements abstract jakarta.el.ELResolver.isReadOnly.

Readonly, so return true

Parameters
context:ELContext

Doc from jakarta.el.ELResolver.isReadOnly.

The context of this evaluation.

base:Object

Doc from jakarta.el.ELResolver.isReadOnly.

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

property:Object

Doc from jakarta.el.ELResolver.isReadOnly.

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

Returns:boolean

Doc from jakarta.el.ELResolver.isReadOnly.

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
See Also
jakarta.el.ELResolver#isReadOnly(jakarta.el.ELContext, Object, Object)
setValueback to summary
public void setValue(ELContext context, Object base, Object property, Object value)

Implements abstract jakarta.el.ELResolver.setValue.

This is 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
See Also
ELResolver#setValue(jakarta.el.ELContext, Object, Object, Object)
com.sun.faces.el back to summary

private final Class CompositeComponentAttributesELResolver.ExpressionEvalMap

extends Object
implements Map<String, Object>, CompositeComponentExpressionHolder
Class Inheritance
  • java.lang.Object
  • com.sun.faces.el.CompositeComponentAttributesELResolver.ExpressionEvalMap
All Implemented Interfaces
jakarta.faces.el.CompositeComponentExpressionHolder, java.util.Map
Simple Map implementation to evaluate any ValueExpression stored directly within the provided attributes map.

Field Summary

Modifier and TypeField and Description
private final Map<String, Object>
attributesMap

private final UIComponent
cc

private FacesContext
ctx

private PropertyDescriptor[]
declaredAttributes

private Map<Object, Object>
declaredDefaultValues

Constructor Summary

AccessConstructor and Description
pack-priv
ExpressionEvalMap(FacesContext ctx, UIComponent cc)

Method Summary

Modifier and TypeMethod and Description
public void
clear()

Implements java.util.Map.clear.

Removes all of the mappings from this map (optional operation).

public boolean
containsKey(Object
key whose presence in this map is to be tested
key)

Implements java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key.

public boolean
containsValue(Object
value whose presence in this map is to be tested
value)

Implements java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value.

public Set<Map.Entry<String, Object>>
entrySet()

Implements java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map.

public Object
get(Object
the key whose associated value is to be returned
key)

Implements java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

private Object
getDeclaredDefaultValue(Object key)

public ValueExpression
getExpression(String
that attribute name which may be associated with a ValueExpression
name)

Implements jakarta.faces.el.CompositeComponentExpressionHolder.getExpression.

public boolean
isEmpty()

Implements java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

public Set<String>
keySet()

Implements java.util.Map.keySet.

Returns a Set view of the keys contained in this map.

public Object
put(String
key with which the specified value is to be associated
key, Object
value to be associated with the specified key
value)

Implements java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation).

public void
putAll(Map<? extends String, ?>
mappings to be stored in this map
t)

Implements java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation).

public Object
remove(Object
key whose mapping is to be removed from the map
key)

Implements java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation).

public int
size()

Implements java.util.Map.size.

Returns the number of key-value mappings in this map.

public void
updateFacesContext(FacesContext ctx)

public Collection<Object>
values()

Implements java.util.Map.values.

Returns a Collection view of the values contained in this map.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attributesMapback to summary
private final Map<String, Object> attributesMap
ccback to summary
private final UIComponent cc
ctxback to summary
private FacesContext ctx
declaredAttributesback to summary
private PropertyDescriptor[] declaredAttributes
declaredDefaultValuesback to summary
private Map<Object, Object> declaredDefaultValues

Constructor Detail

ExpressionEvalMapback to summary
pack-priv ExpressionEvalMap(FacesContext ctx, UIComponent cc)

Method Detail

clearback to summary
public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Annotations
@Override
containsKeyback to summary
public boolean containsKey(Object key)

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters
key:Object

key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

Annotations
@Override
containsValueback to summary
public boolean containsValue(Object value)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters
value:Object

value whose presence in this map is to be tested

Returns:boolean

true if this map maps one or more keys to the specified value

Annotations
@Override
entrySetback to summary
public Set<Map.Entry<String, Object>> entrySet()

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<Map.Entry<String, Object>>

a set view of the mappings contained in this map

Annotations
@Override
getback to summary
public Object get(Object key)

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters
key:Object

the key whose associated value is to be returned

Returns:Object

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations
@Override
getDeclaredDefaultValueback to summary
private Object getDeclaredDefaultValue(Object key)
getExpressionback to summary
public ValueExpression getExpression(String name)

Implements jakarta.faces.el.CompositeComponentExpressionHolder.getExpression.

Parameters
name:String

Doc from jakarta.faces.el.CompositeComponentExpressionHolder.getExpression.

that attribute name which may be associated with a ValueExpression

Returns:ValueExpression

Doc from jakarta.faces.el.CompositeComponentExpressionHolder.getExpression.

the ValueExpression associated with name otherwise return null

Annotations
@Override
isEmptyback to summary
public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean

true if this map contains no key-value mappings

Annotations
@Override
keySetback to summary
public Set<String> keySet()

Implements java.util.Map.keySet.

Doc from java.util.Map.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<String>

a set view of the keys contained in this map

Annotations
@Override
putback to summary
public Object put(String key, Object value)

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters
key:String

key with which the specified value is to be associated

value:Object

value to be associated with the specified key

Returns:Object

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Annotations
@Override
putAllback to summary
public void putAll(Map<? extends String, ?> t)

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters
t:Map<? extends String, ?>

mappings to be stored in this map

Annotations
@Override
removeback to summary
public Object remove(Object key)

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters
key:Object

key whose mapping is to be removed from the map

Returns:Object

the previous value associated with key, or null if there was no mapping for key.

Annotations
@Override
sizeback to summary
public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of key-value mappings in this map

Annotations
@Override
updateFacesContextback to summary
public void updateFacesContext(FacesContext ctx)
valuesback to summary
public Collection<Object> values()

Implements java.util.Map.values.

Doc from java.util.Map.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<Object>

a collection view of the values contained in this map

Annotations
@Override