This specialized MethodExpression enables the evaluation of composite component expressions. Instances of this expression will be created when com.sun.faces.facelets.tag.TagAttributeImpl#getValueExpression(jakarta.faces.view.facelets.FaceletContext, Class) is invoked and the expression represents a composite component expression (i.e. #{cc.[properties]}).

It's important to note that these MethodExpressions are context sensitive in that they leverage the location in which they were referenced in order to push the proper composite component to the evaluation context prior to evaluating the expression itself.

Here's an example:

Using Page test.xhtml
---------------------------------
   <ez:comp1 do="#{bean.action}" />


comp1.xhtml
---------------------------------
<composite:interface>
   <composite:attribute name="do" method-signature="String f()" required="true" />
</composite:interface>
<composite:implementation>
   <ez:nesting>
      <h:commandButton value="Click Me!" action="#{cc.attrs.do} />
   </ez:nesting>
</composite:implementation>

nesting.xhtml
---------------------------------
<composite:interface />
<composite:implementation>
   <composite:insertChildren>
</composite:implementation>

When commandButton is clicked, the ContextualCompositeMethodExpression first is looked up by com.sun.faces.facelets.tag.TagAttributeImpl.AttributeLookupMethodExpression which results an instance of ContextualCompositeMethodExpression. When this ContextualCompositeMethodExpression is invoked, the jakarta.faces.view.Location object necessary to find the proper composite component will be derived from source ValueExpression provided at construction time. Using the derived jakarta.faces.view.Location, we can find the composite component that matches 'owns' the template in which the expression was defined in by comparing the path of the Location with the name and library of the jakarta.faces.application.Resource instance associated with each composite component. If a matching composite component is found, it will be made available to the EL by calling CompositeComponentStackManager#push(jakarta.faces.component.UIComponent).

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	ContextualCompositeMethodExpression.SetClientIdListener

Field Summary

Modifier and Type	Field and Description
private String	ccClientId
private final MethodExpression	delegate
private final Location	location
private static final Logger	LOGGER
private static final long	serialVersionUID Hides jakarta.el.MethodExpression.serialVersionUID.
private final ValueExpression	source

Constructor Summary

Access	Constructor and Description
public	ContextualCompositeMethodExpression(ValueExpression source, MethodExpression delegate)
public	ContextualCompositeMethodExpression(Location location, MethodExpression delegate)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the `Object` to test for equality. o) Implements abstract jakarta.el.Expression.equals. Determines whether the specified object is equal to this `Expression`.
public String	getExpressionString() Implements abstract jakarta.el.Expression.getExpressionString. Returns the original String used to create this `Expression`, unmodified.
public MethodInfo	getMethodInfo(ELContext The context of this evaluation elContext) Implements abstract jakarta.el.MethodExpression.getMethodInfo. Evaluates the expression relative to the provided context, and returns information about the actual referenced method.
public int	hashCode() Implements abstract jakarta.el.Expression.hashCode. Returns the hash code for this `Expression`.
public Object	invoke(ELContext The context of this evaluation. elContext, Object[] The parameters to pass to the method, or `null` if no parameters. objects) Implements abstract jakarta.el.MethodExpression.invoke. If a String literal is specified as the expression, returns the String literal coerced to the expected return type of the method signature.
public boolean	isLiteralText() Implements abstract jakarta.el.Expression.isLiteralText. Returns whether this expression was created from only literal text.
private void	popCompositeComponent(FacesContext ctx)
private boolean	pushCompositeComponent(FacesContext ctx)

Inherited from jakarta.el.MethodExpression:: getMethodReference isParametersProvided

Field Detail

ccClientId	back to summary
private String ccClientId

delegate	back to summary
private final MethodExpression delegate

location	back to summary
private final Location location

LOGGER	back to summary
private static final Logger LOGGER

serialVersionUID	back to summary
private static final long serialVersionUID Hides jakarta.el.MethodExpression.serialVersionUID.

source	back to summary
private final ValueExpression source

Constructor Detail

ContextualCompositeMethodExpression	back to summary
public ContextualCompositeMethodExpression(ValueExpression source, MethodExpression delegate)

ContextualCompositeMethodExpression	back to summary
public ContextualCompositeMethodExpression(Location location, MethodExpression delegate)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Implements abstract jakarta.el.Expression.equals. Doc from jakarta.el.Expression.equals. Determines whether the specified object is equal to this `Expression`. The result is `true` if and only if the argument is not `null`, is an `Expression` object that is the of the same type (`ValueExpression` or `MethodExpression`), and has an identical parsed representation. Note that two expressions can be equal if their expression Strings are different. For example, `${fn1:foo()}` and `${fn2:foo()}` are equal if their corresponding `FunctionMapper`s mapped `fn1:foo` and `fn2:foo` to the same method. Parameters o:Object the `Object` to test for equality. Returns:boolean `true` if `obj` equals this `Expression`; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Implements abstract jakarta.el.Expression.equals.

Doc from jakarta.el.Expression.equals.

Determines whether the specified object is equal to this Expression.

The result is true if and only if the argument is not null, is an Expression object that is the of the same type (ValueExpression or MethodExpression), and has an identical parsed representation.

Note that two expressions can be equal if their expression Strings are different. For example, ${fn1:foo()} and ${fn2:foo()} are equal if their corresponding FunctionMappers mapped fn1:foo and fn2:foo to the same method.

Parameters

o:Object: the Object to test for equality.

Returns:boolean

true if obj equals this Expression; false otherwise.

Annotations

@Override

getExpressionString back to summary

getExpressionString	back to summary
public String getExpressionString() Implements abstract jakarta.el.Expression.getExpressionString. Doc from jakarta.el.Expression.getExpressionString. Returns the original String used to create this `Expression`, unmodified. This is used for debugging purposes but also for the purposes of comparison (e.g. to ensure the expression in a configuration file has not changed). This method does not provide sufficient information to re-create an expression. Two different expressions can have exactly the same expression string but different function mappings. Serialization should be used to save and restore the state of an `Expression`. Returns:String The original expression String. Annotations @Override

public String getExpressionString()

Implements abstract jakarta.el.Expression.getExpressionString.

Doc from jakarta.el.Expression.getExpressionString.

Returns the original String used to create this Expression, unmodified.

This is used for debugging purposes but also for the purposes of comparison (e.g. to ensure the expression in a configuration file has not changed).

This method does not provide sufficient information to re-create an expression. Two different expressions can have exactly the same expression string but different function mappings. Serialization should be used to save and restore the state of an Expression.

Returns:String

The original expression String.

Annotations

@Override

getMethodInfo back to summary

getMethodInfo	back to summary
public MethodInfo getMethodInfo(ELContext elContext) Implements abstract jakarta.el.MethodExpression.getMethodInfo. Doc from jakarta.el.MethodExpression.getMethodInfo. Evaluates the expression relative to the provided context, and returns information about the actual referenced method. Parameters elContext:ELContext The context of this evaluation Returns:MethodInfo an instance of `MethodInfo` containing information about the method the expression evaluated to. Annotations @Override

public MethodInfo getMethodInfo(ELContext elContext)

Implements abstract jakarta.el.MethodExpression.getMethodInfo.

Doc from jakarta.el.MethodExpression.getMethodInfo.

Evaluates the expression relative to the provided context, and returns information about the actual referenced method.

Parameters

elContext:ELContext: The context of this evaluation

Returns:MethodInfo

an instance of MethodInfo containing information about the method the expression evaluated to.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Implements abstract jakarta.el.Expression.hashCode. Doc from jakarta.el.Expression.hashCode. Returns the hash code for this `Expression`. See the note in the `equals` method on how two expressions can be equal if their expression Strings are different. Recall that if two objects are equal according to the `equals(Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. Implementations must take special note and implement `hashCode` correctly. Returns:int The hash code for this `Expression`. Annotations @Override

public int hashCode()

Implements abstract jakarta.el.Expression.hashCode.

Doc from jakarta.el.Expression.hashCode.

Returns the hash code for this Expression.

See the note in the equals method on how two expressions can be equal if their expression Strings are different. Recall that if two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. Implementations must take special note and implement hashCode correctly.

Returns:int

The hash code for this Expression.

Annotations

@Override

invoke back to summary

invoke	back to summary
public Object invoke(ELContext elContext, Object[] objects) Implements abstract jakarta.el.MethodExpression.invoke. Doc from jakarta.el.MethodExpression.invoke. If a String literal is specified as the expression, returns the String literal coerced to the expected return type of the method signature. An `ELException` is thrown if `expectedReturnType` is void or if the coercion of the String literal to the `expectedReturnType` yields an error (see Section "1.18 Type Conversion" of the Jakarta Expression Language specification). If not a String literal, evaluates the expression relative to the provided context, invokes the method that was found using the supplied parameters, and returns the result of the method invocation. Any parameters passed to this method is ignored if isLiteralText() or isParametersProvided() is true. Parameters elContext:ELContext The context of this evaluation. objects:Object[] The parameters to pass to the method, or `null` if no parameters. Returns:Object the result of the method invocation (`null` if the method has a `void` return type). Annotations @Override

public Object invoke(ELContext elContext, Object[] objects)

Implements abstract jakarta.el.MethodExpression.invoke.

Doc from jakarta.el.MethodExpression.invoke.

If a String literal is specified as the expression, returns the String literal coerced to the expected return type of the method signature. An ELException is thrown if expectedReturnType is void or if the coercion of the String literal to the expectedReturnType yields an error (see Section "1.18 Type Conversion" of the Jakarta Expression Language specification). If not a String literal, evaluates the expression relative to the provided context, invokes the method that was found using the supplied parameters, and returns the result of the method invocation. Any parameters passed to this method is ignored if isLiteralText() or isParametersProvided() is true.

Parameters

elContext:ELContext: The context of this evaluation.
objects:Object[]: The parameters to pass to the method, or null if no parameters.

Returns:Object

the result of the method invocation (null if the method has a void return type).

Annotations

@Override

isLiteralText back to summary

isLiteralText	back to summary
public boolean isLiteralText() Implements abstract jakarta.el.Expression.isLiteralText. Doc from jakarta.el.Expression.isLiteralText. Returns whether this expression was created from only literal text. This method must return `true` if and only if the expression string this expression was created from contained no unescaped Jakarta Expression Language delimeters (`${...}` or `#{...}`). Returns:boolean `true` if this expression was created from only literal text; `false` otherwise. Annotations @Override

public boolean isLiteralText()

Implements abstract jakarta.el.Expression.isLiteralText.

Doc from jakarta.el.Expression.isLiteralText.

Returns whether this expression was created from only literal text.

This method must return true if and only if the expression string this expression was created from contained no unescaped Jakarta Expression Language delimeters (${...} or #{...}).

Returns:boolean

true if this expression was created from only literal text; false otherwise.

Annotations

@Override

popCompositeComponent	back to summary
private void popCompositeComponent(FacesContext ctx)

pushCompositeComponent	back to summary
private boolean pushCompositeComponent(FacesContext ctx)

com.sun.faces.facelets.el back to summary

private Class ContextualCompositeMethodExpression.SetClientIdListener

Class Inheritance

extends Object
implements ComponentSystemEventListener

java.lang.Object
com.sun.faces.facelets.el.ContextualCompositeMethodExpression.SetClientIdListener

All Implemented Interfaces

jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, java.util.EventListener

Field Summary

Modifier and Type	Field and Description
private ContextualCompositeMethodExpression	ccME

Constructor Summary

Access	Constructor and Description
public	SetClientIdListener(ContextualCompositeMethodExpression ccME)

Method Summary

Modifier and Type	Method and Description
public void	processEvent(ComponentSystemEvent the `ComponentSystemEvent` instance that is being processed. event) Implements jakarta.faces.event.ComponentSystemEventListener.processEvent. When called, the listener can assume that any guarantees given in the javadoc for the specific `SystemEvent` subclass are true.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ccME	back to summary
private ContextualCompositeMethodExpression ccME

Constructor Detail

SetClientIdListener	back to summary
public SetClientIdListener(ContextualCompositeMethodExpression ccME)

Method Detail

processEvent back to summary

processEvent	back to summary
public void processEvent(ComponentSystemEvent event) throws AbortProcessingException Implements jakarta.faces.event.ComponentSystemEventListener.processEvent. Doc from jakarta.faces.event.ComponentSystemEventListener.processEvent. When called, the listener can assume that any guarantees given in the javadoc for the specific `SystemEvent` subclass are true. Parameters event:ComponentSystemEvent the `ComponentSystemEvent` instance that is being processed. Annotations @Override Exceptions AbortProcessingException: if lifecycle processing should cease for this request.

public void processEvent(ComponentSystemEvent event) throws AbortProcessingException

Implements jakarta.faces.event.ComponentSystemEventListener.processEvent.

Doc from jakarta.faces.event.ComponentSystemEventListener.processEvent.

When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true.

Parameters

event:ComponentSystemEvent: the ComponentSystemEvent instance that is being processed.

Annotations

@Override

Exceptions

AbortProcessingException:: if lifecycle processing should cease for this request.

public Class ContextualCompositeMethodExpression

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ContextualCompositeMethodExpression.SetClientIdListener

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail