FileDocCategorySizeDatePackage
ELContext.javaAPI DocGlassfish v2 API8529Tue Mar 20 09:32:54 GMT 2007javax.el

ELContext

public abstract class ELContext extends Object
Context information for expression evaluation.

To evaluate an {@link Expression}, an ELContext must be provided. The ELContext holds:

  • a reference to the base {@link ELResolver} that will be consulted to resolve model objects and their properties
  • a reference to {@link FunctionMapper} that will be used to resolve EL Functions.
  • a reference to {@link VariableMapper} that will be used to resolve EL Variables.
  • a collection of all the relevant context objects for use by ELResolvers
  • state information during the evaluation of an expression, such as whether a property has been resolved yet

The collection of context objects is necessary because each ELResolver may need access to a different context object. For example, JSP and Faces resolvers need access to a {@link javax.servlet.jsp.JspContext} and a {@link javax.faces.context.FacesContext}, respectively.

Creation of ELContext objects is controlled through the underlying technology. For example, in JSP the JspContext.getELContext() factory method is used. Some technologies provide the ability to add an {@link ELContextListener} so that applications and frameworks can ensure their own context objects are attached to any newly created ELContext.

Because it stores state during expression evaluation, an ELContext object is not thread-safe. Care should be taken to never share an ELContext instance between two or more threads.

see
ELContextListener
see
ELContextEvent
see
ELResolver
see
FunctionMapper
see
VariableMapper
see
javax.servlet.jsp.JspContext
since
JSP 2.1

Fields Summary
private Locale
locale
Holds value of property locale.
private boolean
resolved
private HashMap
map
Constructors Summary
Methods Summary
public java.lang.ObjectgetContext(java.lang.Class key)
Returns the context object associated with the given key.

The ELContext maintains a collection of context objects relevant to the evaluation of an expression. These context objects are used by ELResolvers. This method is used to retrieve the context with the given key from the collection.

By convention, the object returned will be of the type specified by the key. However, this is not required and the key is used strictly as a unique identifier.

param
key The unique identifier that was used to associate the context object with this ELContext.
return
The context object associated with the given key, or null if no such context was found.
throws
NullPointerException if key is null.

        if(key == null) {
            throw new NullPointerException();
        }
        return map.get(key);
    
public abstract javax.el.ELResolvergetELResolver()
Retrieves the ELResolver associated with this context.

The ELContext maintains a reference to the ELResolver that will be consulted to resolve variables and properties during an expression evaluation. This method retrieves the reference to the resolver.

Once an ELContext is constructed, the reference to the ELResolver associated with the context cannot be changed.

return
The resolver to be consulted for variable and property resolution during expression evaluation.

public abstract javax.el.FunctionMappergetFunctionMapper()
Retrieves the FunctionMapper associated with this ELContext.

return
The function mapper to be consulted for the resolution of EL functions.

public java.util.LocalegetLocale()
Get the Locale stored by a previous invocation to {@link #setLocale}. If this method returns non null, this Locale must be used for all localization needs in the implementation. The Locale must not be cached to allow for applications that change Locale dynamically.

return
The Locale in which this instance is operating. Used primarily for message localization.


        return this.locale;
    
public abstract javax.el.VariableMappergetVariableMapper()
Retrieves the VariableMapper associated with this ELContext.

return
The variable mapper to be consulted for the resolution of EL variables.

public booleanisPropertyResolved()
Returns whether an {@link ELResolver} has successfully resolved a given (base, property) pair.

The {@link CompositeELResolver} checks this property to determine whether it should consider or skip other component resolvers.

see
CompositeELResolver
return
true if the property has been resolved, or false if not.

        return resolved;
    
public voidputContext(java.lang.Class key, java.lang.Object contextObject)
Associates a context object with this ELContext.

The ELContext maintains a collection of context objects relevant to the evaluation of an expression. These context objects are used by ELResolvers. This method is used to add a context object to that collection.

By convention, the contextObject will be of the type specified by the key. However, this is not required and the key is used strictly as a unique identifier.

param
key The key used by an @{link ELResolver} to identify this context object.
param
contextObject The context object to add to the collection.
throws
NullPointerException if key is null or contextObject is null.

        if((key == null) || (contextObject == null)) {
            throw new NullPointerException();
        }
        map.put(key, contextObject);
    
public voidsetLocale(java.util.Locale locale)
Set the Locale for this instance. This method may be called by the party creating the instance, such as JavaServer Faces or JSP, to enable the EL implementation to provide localized messages to the user. If no Locale is set, the implementation must use the locale returned by Locale.getDefault( ).


        this.locale = locale;
    
public voidsetPropertyResolved(boolean resolved)
Called to indicate that a ELResolver has successfully resolved a given (base, property) pair.

The {@link CompositeELResolver} checks this property to determine whether it should consider or skip other component resolvers.

see
CompositeELResolver
param
resolved true if the property has been resolved, or false if not.

        this.resolved = resolved;