- All Implemented Interfaces:
Serializable
This specialized ValueExpression enables the evaluation of composite component expressions. Instances of
this expression will be created when
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 ValueExpressions 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.
Using Page test.xhtml
---------------------------------
<ez:comp1 greeting="Hello!" />
comp1.xhtml
---------------------------------
<composite:interface>
<composite:attribute name="greeting" type="java.lang.String" required="true" />
</composite:interface>
<composite:implementation>
<ez:nesting>
<h:outputText value="#{cc.attrs.greetings}" />
</ez:nesting>
</composite:implementation>
nesting.xhtml
---------------------------------
<composite:interface />
<composite:implementation>
<composite:insertChildren>
</composite:implementation>
In the above example, there will be two composite components available to the runtime: ez:comp1 and
ez:nesting.
When <h:outputText value="#{cc.attrs.greeting}" />, prior to attempting to evaluate the expression, the
Location object will be used to find the composite component that 'owns' the template in which the expression
was defined in by comparing the path of the Location with the name and library of the
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).
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionContextualCompositeValueExpression(Location location, ValueExpression originalVE) -
Method Summary
Modifier and TypeMethodDescriptionbooleanDetermines whether the specified object is equal to thisExpression.Class<?> Returns the type the result of the expression will be coerced to after evaluation.Returns the original String used to create thisExpression, unmodified.Class<?> Evaluates the expression relative to the provided context, and returns the most general type that is acceptable for an object to be passed as thevalueparameter in a future call to theValueExpression.setValue(jakarta.el.ELContext, java.lang.Object)method.Evaluates the expression relative to the provided context, and returns the resulting value.getValueReference(ELContext elContext) Returns aValueReferencefor this expression instance.inthashCode()Returns the hash code for thisExpression.booleanReturns whether this expression was created from only literal text.booleanisReadOnly(ELContext elContext) Evaluates the expression relative to the provided context, and returnstrueif a call toValueExpression.setValue(jakarta.el.ELContext, java.lang.Object)will always fail.voidEvaluates the expression relative to the provided context, and sets the result to the provided value.toString()
-
Constructor Details
-
ContextualCompositeValueExpression
public ContextualCompositeValueExpression() -
ContextualCompositeValueExpression
-
-
Method Details
-
getValue
Description copied from class:ValueExpressionEvaluates the expression relative to the provided context, and returns the resulting value.The resulting value is automatically coerced to the type returned by
getExpectedType(), which was provided to theExpressionFactorywhen this expression was created.- Specified by:
getValuein classValueExpression- Parameters:
elContext- The context of this evaluation.- Returns:
- The result of the expression evaluation.
-
setValue
Description copied from class:ValueExpressionEvaluates the expression relative to the provided context, and sets the result to the provided value.- Specified by:
setValuein classValueExpression- Parameters:
elContext- The context of this evaluation.o- The new value to be set.
-
isReadOnly
Description copied from class:ValueExpressionEvaluates the expression relative to the provided context, and returnstrueif a call toValueExpression.setValue(jakarta.el.ELContext, java.lang.Object)will always fail.- Specified by:
isReadOnlyin classValueExpression- Parameters:
elContext- The context of this evaluation.- Returns:
trueif the expression is read-only orfalseif not.
-
getType
Description copied from class:ValueExpressionEvaluates the expression relative to the provided context, and returns the most general type that is acceptable for an object to be passed as thevalueparameter in a future call to theValueExpression.setValue(jakarta.el.ELContext, java.lang.Object)method.This is not always the same as
getValue().getClass(). For example, in the case of an expression that references an array element, thegetTypemethod 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.- Specified by:
getTypein classValueExpression- Parameters:
elContext- The context of this evaluation.- Returns:
- the most general acceptable type; otherwise undefined.
-
getExpectedType
Description copied from class:ValueExpressionReturns the type the result of the expression will be coerced to after evaluation.- Specified by:
getExpectedTypein classValueExpression- Returns:
- the
expectedTypepassed to theExpressionFactory.createValueExpressionmethod that created thisValueExpression.
-
getValueReference
Description copied from class:ValueExpressionReturns aValueReferencefor this expression instance.- Overrides:
getValueReferencein classValueExpression- Parameters:
elContext- the context of this evaluation- Returns:
- the
ValueReferencefor thisValueExpression, ornullif thisValueExpressionis not a reference to a base (null or non-null) and a property. If the base is null, and the property is a Jakarta Expression Language variable, return theValueReferencefor theValueExpressionassociated with this Jakarta Expression Language variable.
-
getExpressionString
Description copied from class:ExpressionReturns the original String used to create thisExpression, 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.- Specified by:
getExpressionStringin classExpression- Returns:
- The original expression String.
-
equals
Description copied from class:ExpressionDetermines whether the specified object is equal to thisExpression.The result is
trueif and only if the argument is notnull, is anExpressionobject that is the of the same type (ValueExpressionorMethodExpression), 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 correspondingFunctionMappers mappedfn1:fooandfn2:footo the same method.- Specified by:
equalsin classExpression- Parameters:
o- theObjectto test for equality.- Returns:
trueifobjequals thisExpression;falseotherwise.- See Also:
-
hashCode
public int hashCode()Description copied from class:ExpressionReturns the hash code for thisExpression.See the note in the
Expression.equals(java.lang.Object)method on how two expressions can be equal if their expression Strings are different. Recall that if two objects are equal according to theequals(Object)method, then calling thehashCodemethod on each of the two objects must produce the same integer result. Implementations must take special note and implementhashCodecorrectly.- Specified by:
hashCodein classExpression- Returns:
- The hash code for this
Expression. - See Also:
-
isLiteralText
public boolean isLiteralText()Description copied from class:ExpressionReturns whether this expression was created from only literal text.This method must return
trueif and only if the expression string this expression was created from contained no unescaped Jakarta Expression Language delimeters (${...}or#{...}).- Specified by:
isLiteralTextin classExpression- Returns:
trueif this expression was created from only literal text;falseotherwise.
-
toString
-
getLocation
-