Save This Page
Home » glassfish-v2ur2-b04-src » javax » el » [javadoc | source]
javax.el
public class: BeanELResolver [javadoc | source]
java.lang.Object
   javax.el.ELResolver
      javax.el.BeanELResolver
Defines property resolution behavior on objects using the JavaBeans component architecture.

This resolver handles base objects of any type, as long as the base is not null. It accepts any object as a property, and coerces it to a string. That string is then used to find a JavaBeans compliant property on the base object. The value is accessed using JavaBeans getters and setters.

This resolver can be constructed in read-only mode, which means that #isReadOnly will always return true and #setValue will always throw PropertyNotWritableException.

ELResolvers are combined together using CompositeELResolver s, to define rich semantics for evaluating an expression. See the javadocs for ELResolver for details.

Because this resolver handles base objects of any type, it should be placed near the end of a composite resolver. Otherwise, it will claim to have resolved a property before any resolvers that come after it get a chance to test if they can do so as well.

Nested Class Summary:
protected static final class  BeanELResolver.BeanProperty   
protected static final class  BeanELResolver.BeanProperties   
Fields inherited from javax.el.ELResolver:
TYPE,  RESOLVABLE_AT_DESIGN_TIME
Constructor:
 public BeanELResolver() 
 public BeanELResolver(boolean isReadOnly) 
Method from javax.el.BeanELResolver Summary:
getCommonPropertyType,   getFeatureDescriptors,   getType,   getValue,   isReadOnly,   setValue
Methods from javax.el.ELResolver:
getCommonPropertyType,   getFeatureDescriptors,   getType,   getValue,   isReadOnly,   setValue
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.el.BeanELResolver Detail:
 public Class getCommonPropertyType(ELContext context,
    Object base) 
    If the base object is not null, returns the most general type that this resolver accepts for the property argument. Otherwise, returns null.

    Assuming the base is not null, this method will always return Object.class. This is because any object is accepted as a key and is coerced into a string.

 public Iterator getFeatureDescriptors(ELContext context,
    Object base) 
    If the base object is not null, returns an Iterator containing the set of JavaBeans properties available on the given object. Otherwise, returns null.

    The Iterator returned must contain zero or more instances of java.beans.FeatureDescriptor . Each info object contains information about a property in the bean, as obtained by calling the BeanInfo.getPropertyDescriptors method. The FeatureDescriptor is initialized using the same fields as are present in the PropertyDescriptor, with the additional required named attributes "type" and "resolvableAtDesignTime" set as follows:

  • ELResolver#TYPE - The runtime type of the property, from PropertyDescriptor.getPropertyType().
  • ELResolver#RESOLVABLE_AT_DESIGN_TIME - true.
 public Class getType(ELContext context,
    Object base,
    Object property) 
    If the base object is not null, returns the most general acceptable type that can be set on this bean property.

    If the base is not null, 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.

    The provided property will first be coerced to a String. If there is a BeanInfoProperty for this property and there were no errors retrieving it, the propertyType of the propertyDescriptor is returned. Otherwise, a PropertyNotFoundException is thrown.

 public Object getValue(ELContext context,
    Object base,
    Object property) 
    If the base object is not null, returns the current value of the given property on this bean.

    If the base is not null, 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.

    The provided property name will first be coerced to a String. If the property is a readable property of the base object, as per the JavaBeans specification, then return the result of the getter call. If the getter throws an exception, it is propagated to the caller. If the property is not found or is not readable, a PropertyNotFoundException is thrown.

 public boolean isReadOnly(ELContext context,
    Object base,
    Object property) 
    If the base object is not null, returns whether a call to #setValue will always fail.

    If the base is not null, 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, this method will always return true.

    The provided property name will first be coerced to a String. If property is a writable property of base, false is returned. If the property is found but is not writable, true is returned. If the property is not found, a PropertyNotFoundException is thrown.

 public  void setValue(ELContext context,
    Object base,
    Object property,
    Object val) 
    If the base object is not null, attempts to set the value of the given property on this bean.

    If the base is not null, 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, this method will always throw PropertyNotWritableException.

    The provided property name will first be coerced to a String. If property is a writable property of base (as per the JavaBeans Specification), the setter method is called (passing value). If the property exists but does not have a setter, then a PropertyNotFoundException is thrown. If the property does not exist, a PropertyNotFoundException is thrown.