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

public final Class LegacyELContext

extends ELContext
Class Inheritance
Imports
javax.el.*, javax.faces.context.ExternalContext, .FacesContext, javax.faces.el.EvaluationException, .PropertyNotFoundException, .PropertyResolver, .VariableResolver, java.lang.reflect.Method, java.util.*

Deprecated

Author
Jacob Hookom
Version
$Id$

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private class

Field Summary

Modifier and TypeField and Description
private final FacesContext
private static final FunctionMapper
private static final String[]
private final ELResolver
private final VariableMapper

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public ELResolver
getELResolver()

Implements abstract javax.el.ELContext.getELResolver.

Retrieves the ELResolver associated with this context.
public FacesContext
public FunctionMapper
getFunctionMapper()

Implements abstract javax.el.ELContext.getFunctionMapper.

Retrieves the FunctionMapper associated with this ELContext.
public VariableMapper
getVariableMapper()

Implements abstract javax.el.ELContext.getVariableMapper.

Retrieves the VariableMapper associated with this ELContext.
Inherited from javax.el.ELContext:
addEvaluationListenerconvertToTypeenterLambdaScopeexitLambdaScopegetContextgetEvaluationListenersgetImportHandlergetLambdaArgumentgetLocaleisLambdaArgumentisPropertyResolvednotifyAfterEvaluationnotifyBeforeEvaluationnotifyPropertyResolvedputContextsetLocalesetPropertyResolvedsetPropertyResolved

Field Detail

facesback to summary
private final FacesContext faces
FUNCTIONSback to summary
private static final FunctionMapper FUNCTIONS
IMPLICIT_OBJECTSback to summary
private static final String[] IMPLICIT_OBJECTS
resolverback to summary
private final ELResolver resolver
variablesback to summary
private final VariableMapper variables

Constructor Detail

LegacyELContextback to summary
public LegacyELContext(FacesContext faces)

Method Detail

getELResolverback to summary
public ELResolver getELResolver()

Implements abstract javax.el.ELContext.getELResolver.

Doc from javax.el.ELContext.getELResolver.

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.

Returns:ELResolver

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

Annotations
@Override
getFacesContextback to summary
public FacesContext getFacesContext()
getFunctionMapperback to summary
public FunctionMapper getFunctionMapper()

Implements abstract javax.el.ELContext.getFunctionMapper.

Doc from javax.el.ELContext.getFunctionMapper.

Retrieves the FunctionMapper associated with this ELContext.

Returns:FunctionMapper

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

Annotations
@Override
getVariableMapperback to summary
public VariableMapper getVariableMapper()

Implements abstract javax.el.ELContext.getVariableMapper.

Doc from javax.el.ELContext.getVariableMapper.

Retrieves the VariableMapper associated with this ELContext.

Returns:VariableMapper

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

Annotations
@Override
com.sun.faces.facelets.el back to summary

private final Class LegacyELContext.EmptyFunctionMapper

extends FunctionMapper
Class Inheritance

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public Method
resolveFunction(String
the prefix of the function, or "" if no prefix. For example, "fn" in ${fn:method()}, or "" in ${method()}.
prefix
,
String
the short name of the function. For example, "method" in ${fn:method()}.
localName
)

Implements abstract javax.el.FunctionMapper.resolveFunction.

Resolves the specified prefix and local name into a java.lang.Method.
Inherited from javax.el.FunctionMapper:
mapFunction

Constructor Detail

EmptyFunctionMapperback to summary
private EmptyFunctionMapper()

Method Detail

resolveFunctionback to summary
public Method resolveFunction(String prefix, String localName)

Implements abstract javax.el.FunctionMapper.resolveFunction.

Doc from javax.el.FunctionMapper.resolveFunction.

Resolves the specified prefix and local name into a java.lang.Method.

Returns null if no function could be found that matches the given prefix and local name.

Parameters
prefix:String

the prefix of the function, or "" if no prefix. For example, "fn" in ${fn:method()}, or "" in ${method()}.

localName:String

the short name of the function. For example, "method" in ${fn:method()}.

Returns:Method

the static method to invoke, or null if no match was found.

Annotations
@Override
com.sun.faces.facelets.el back to summary

private final Class LegacyELContext.LegacyELResolver

extends ELResolver
Class Inheritance

Field Summary

Inherited from javax.el.ELResolver:
RESOLVABLE_AT_DESIGN_TIMETYPE

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public Class<T>
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 javax.el.ELResolver.getCommonPropertyType.

Returns the most general type that this resolver accepts for the property argument, given a base object.
public Iterator<E>
getFeatureDescriptors(ELContext
The context of this evaluation.
context
,
Object
The base object whose set of valid properties is to be enumerated, or null to enumerate the set of top-level variables that this resolver can evaluate.
base
)

Implements abstract javax.el.ELResolver.getFeatureDescriptors.

Returns information about the set of variables or properties that can be resolved for the given base object.
private PropertyResolver
getPropertyResolver()

Deprecated as a consequence of PropertyResolver being deprecated.
public Class<T>
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 javax.el.ELResolver.getType.

For a given base and property, attempts to identify the most general type that is acceptable for an object to be passed as the value parameter in a future call to the setValue method.
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 javax.el.ELResolver.getValue.

Attempts to resolve the given property object on the given base object.
private VariableResolver
getVariableResolver()

Deprecated as a consequence of VariableResolver being deprecated.
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 javax.el.ELResolver.isReadOnly.

For a given base and property, attempts to determine whether a call to setValue will always fail.
private Map<K, V>
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 javax.el.ELResolver.setValue.

Attempts to set the value of the given property object on the given base object.
Inherited from javax.el.ELResolver:
convertToTypeinvoke

Constructor Detail

LegacyELResolverback to summary
private LegacyELResolver()

Method Detail

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

Implements abstract javax.el.ELResolver.getCommonPropertyType.

Doc from javax.el.ELResolver.getCommonPropertyType.

Returns the most general type that this resolver accepts for the property argument, given a base object. One use for this method is to assist tools in auto-completion.

This assists tools in auto-completion and also provides a way to express that the resolver accepts a primitive value, such as an integer index into an array. For example, the ArrayELResolver will accept any int as a property, so the return value would be Integer.class.

Parameters
context:ELContext

The context of this evaluation.

base: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.

Returns:Class<T>

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
getFeatureDescriptorsback to summary
public Iterator<E> getFeatureDescriptors(ELContext context, Object base)

Implements abstract javax.el.ELResolver.getFeatureDescriptors.

Doc from javax.el.ELResolver.getFeatureDescriptors.

Returns information about the set of variables or properties that can be resolved for the given base object. One use for this method is to assist tools in auto-completion.

If the base parameter is null, the resolver must enumerate the list of top-level variables it can resolve.

The Iterator returned must contain zero or more instances of java.beans.FeatureDescriptor, in no guaranteed order. In the case of primitive types such as int, the value null must be returned. This is to prevent the useless iteration through all possible primitive values. A return value of null indicates that this resolver does not handle the given base object or that the results are too complex to represent with this method and the getCommonPropertyType method should be used instead.

Each FeatureDescriptor will contain information about a single variable or property. In addition to the standard properties, the FeatureDescriptor must have two named attributes (as set by the setValue method):

  • TYPE - The value of this named attribute must be an instance of java.lang.Class and specify the runtime type of the variable or property.
  • RESOLVABLE_AT_DESIGN_TIME - The value of this named attribute must be an instance of java.lang.Boolean and indicates whether it is safe to attempt to resolve this property at design-time. For instance, it may be unsafe to attempt a resolution at design time if the ELResolver needs access to a resource that is only available at runtime and no acceptable simulated value can be provided.

The caller should be aware that the Iterator returned might iterate through a very large or even infinitely large set of properties. Care should be taken by the caller to not get stuck in an infinite loop.

This is a "best-effort" list. Not all ELResolvers will return completely accurate results, but all must be callable at both design-time and runtime (i.e. whether or not Beans.isDesignTime() returns true), without causing errors.

The propertyResolved property of the ELContext is not relevant to this method. The results of all ELResolvers are concatenated in the case of composite resolvers.

Parameters
context:ELContext

The context of this evaluation.

base:Object

The base object whose set of valid properties is to be enumerated, or null to enumerate the set of top-level variables that this resolver can evaluate.

Returns:Iterator<E>

An Iterator containing zero or more (possibly infinitely more) FeatureDescriptor objects, or null if this resolver does not handle the given base object or that the results are too complex to represent with this method

Annotations
@Override
getPropertyResolverback to summary
private PropertyResolver getPropertyResolver()

Deprecated

as a consequence of PropertyResolver being deprecated. See corresponding docs for further information.

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

Implements abstract javax.el.ELResolver.getType.

Doc from javax.el.ELResolver.getType.

For a given base and property, attempts to identify the most general type that is acceptable for an object to be passed as the value parameter in a future call to the setValue method.

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

This is not always the same as getValue().getClass(). For example, in the case of an ArrayELResolver, the getType method will return the element type of the array, which might be a superclass of the type of the actual element that is currently in the specified array element.

Parameters
context:ELContext

The context of this evaluation.

base:Object

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

property:Object

The property or variable to return the acceptable type for.

Returns:Class<T>

If the propertyResolved property of ELContext was set to true, then the most general acceptable type; otherwise undefined.

Annotations
@Override
getValueback to summary
public Object getValue(ELContext context, Object base, Object property)

Implements abstract javax.el.ELResolver.getValue.

Doc from javax.el.ELResolver.getValue.

Attempts to resolve the given property object on the given base object.

If this resolver handles the given (base, property) pair, the propertyResolved property of the ELContext object must be set to true by the 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 base object whose property value is to be returned, or null to resolve a top-level variable.

property:Object

The property or variable to be resolved.

Returns:Object

If the propertyResolved property of ELContext was set to true, then the result of the variable or property resolution; otherwise undefined.

Annotations
@Override
getVariableResolverback to summary
private VariableResolver getVariableResolver()

Deprecated

as a consequence of VariableResolver being deprecated. See corresponding docs for further information.

isReadOnlyback to summary
public boolean isReadOnly(ELContext context, Object base, Object property)

Implements abstract javax.el.ELResolver.isReadOnly.

Doc from javax.el.ELResolver.isReadOnly.

For a given base and property, attempts to determine whether a call to setValue will always fail.

If this resolver handles the given (base, property) pair, the propertyResolved property of the ELContext object must be set to true by the 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 base object whose property value is to be analyzed, or null to analyze a top-level variable.

property:Object

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

Returns:boolean

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
resolveScopeback to summary
private Map<K, V> resolveScope(String var)
setValueback to summary
public void setValue(ELContext context, Object base, Object property, Object value)

Implements abstract javax.el.ELResolver.setValue.

Doc from javax.el.ELResolver.setValue.

Attempts to set the value of the given property object on the given base object.

If this resolver handles the given (base, property) pair, the propertyResolved property of the ELContext object must be set to true by the resolver, before returning. If this property is not true after this method is called, the caller can safely assume no value has been set.

Parameters
context:ELContext

The context of this evaluation.

base:Object

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

property:Object

The property or variable to be set.

value:Object

The value to set the property or variable to.

Annotations
@Override