Jakarta EE 11.0.0 · com.sun.faces.facelets.el.TagValueExpression

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides jakarta.el.ValueExpression.serialVersionUID.
private String	tagAttribute
private ValueExpression	wrapped

Access	Constructor and Description
public	TagValueExpression()
public	TagValueExpression(TagAttribute tagAttribute, ValueExpression wrapped)

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 Class<?>	getExpectedType() Implements abstract jakarta.el.ValueExpression.getExpectedType. Returns the type the result of the expression will be coerced to after evaluation.
public String	getExpressionString() Implements abstract jakarta.el.Expression.getExpressionString. Returns the original String used to create this `Expression`, unmodified.
public Class<?>	getType(ELContext The context of this evaluation. context) Implements abstract jakarta.el.ValueExpression.getType. Evaluates the expression relative to the provided context, and returns 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) Implements abstract jakarta.el.ValueExpression.getValue. Evaluates the expression relative to the provided context, and returns the resulting value.
public ValueReference	getValueReference(ELContext the context of this evaluation context) Overrides jakarta.el.ValueExpression.getValueReference. Returns a `ValueReference` for this expression instance.
public ValueExpression	getWrapped()
public int	hashCode() Implements abstract jakarta.el.Expression.hashCode. Returns the hash code for this `Expression`.
public boolean	isLiteralText() Implements abstract jakarta.el.Expression.isLiteralText. Returns whether this expression was created from only literal text.
public boolean	isReadOnly(ELContext The context of this evaluation. context) Implements abstract jakarta.el.ValueExpression.isReadOnly. Evaluates the expression relative to the provided context, and returns `true` if a call to `setValue` will always fail.
public void	readExternal(ObjectInput the stream to read data from in order to restore the object in) Implements java.io.Externalizable.readExternal. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
public void	setValue(ELContext The context of this evaluation. context, Object The new value to be set. value) Implements abstract jakarta.el.ValueExpression.setValue. Evaluates the expression relative to the provided context, and sets the result to the provided value.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writeExternal(ObjectOutput the stream to write the object to out) Implements java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

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

tagAttribute	back to summary
private String tagAttribute

wrapped	back to summary
private ValueExpression wrapped

TagValueExpression	back to summary
public TagValueExpression()

TagValueExpression	back to summary
public TagValueExpression(TagAttribute tagAttribute, ValueExpression wrapped)

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

getExpectedType back to summary

getExpectedType	back to summary
public Class<?> getExpectedType() Implements abstract jakarta.el.ValueExpression.getExpectedType. Doc from jakarta.el.ValueExpression.getExpectedType. Returns the type the result of the expression will be coerced to after evaluation. Returns:Class<?> the `expectedType` passed to the `ExpressionFactory.createValueExpression` method that created this `ValueExpression`. Annotations @Override

public Class<?> getExpectedType()

Implements abstract jakarta.el.ValueExpression.getExpectedType.

Doc from jakarta.el.ValueExpression.getExpectedType.

Returns the type the result of the expression will be coerced to after evaluation.

Returns:Class<?>

the expectedType passed to the ExpressionFactory.createValueExpression method that created this ValueExpression.

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

getType back to summary

getType	back to summary
public Class<?> getType(ELContext context) Implements abstract jakarta.el.ValueExpression.getType. Doc from jakarta.el.ValueExpression.getType. Evaluates the expression relative to the provided context, and returns 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. This is not always the same as `getValue().getClass()`. For example, in the case of an expression that references an array element, 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. Returns:Class<?> the most general acceptable type; otherwise undefined. Annotations @Override

public Class<?> getType(ELContext context)

Implements abstract jakarta.el.ValueExpression.getType.

Doc from jakarta.el.ValueExpression.getType.

Evaluates the expression relative to the provided context, and returns 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.

This is not always the same as getValue().getClass(). For example, in the case of an expression that references an array element, 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.

Returns:Class<?>

the most general acceptable type; otherwise undefined.

Annotations

@Override

getValue back to summary

getValue	back to summary
public Object getValue(ELContext context) Implements abstract jakarta.el.ValueExpression.getValue. Doc from jakarta.el.ValueExpression.getValue. Evaluates 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 the `ExpressionFactory` when this expression was created. Parameters context:ELContext The context of this evaluation. Returns:Object The result of the expression evaluation. Annotations @Override

public Object getValue(ELContext context)

Implements abstract jakarta.el.ValueExpression.getValue.

Doc from jakarta.el.ValueExpression.getValue.

Evaluates 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 the ExpressionFactory when this expression was created.

Parameters

context:ELContext: The context of this evaluation.

Returns:Object

The result of the expression evaluation.

Annotations

@Override

getValueReference back to summary

getValueReference	back to summary
public ValueReference getValueReference(ELContext context) Overrides jakarta.el.ValueExpression.getValueReference. Doc from jakarta.el.ValueExpression.getValueReference. Returns a `ValueReference` for this expression instance. Parameters context:ELContext the context of this evaluation Returns:ValueReference the `ValueReference` for this `ValueExpression`, or `null` if this `ValueExpression` is 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 the `ValueReference` for the `ValueExpression` associated with this Jakarta Expression Language variable. Annotations @Override

public ValueReference getValueReference(ELContext context)

Overrides jakarta.el.ValueExpression.getValueReference.

Doc from jakarta.el.ValueExpression.getValueReference.

Returns a ValueReference for this expression instance.

Parameters

context:ELContext: the context of this evaluation

Returns:ValueReference

the ValueReference for this ValueExpression, or null if this ValueExpression is 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 the ValueReference for the ValueExpression associated with this Jakarta Expression Language variable.

Annotations

@Override

getWrapped	back to summary
public ValueExpression getWrapped()

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

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

isReadOnly back to summary

isReadOnly	back to summary
public boolean isReadOnly(ELContext context) Implements abstract jakarta.el.ValueExpression.isReadOnly. Doc from jakarta.el.ValueExpression.isReadOnly. Evaluates the expression relative to the provided context, and returns `true` if a call to `setValue` will always fail. Parameters context:ELContext The context of this evaluation. Returns:boolean `true` if the expression is read-only or `false` if not. Annotations @Override

public boolean isReadOnly(ELContext context)

Implements abstract jakarta.el.ValueExpression.isReadOnly.

Doc from jakarta.el.ValueExpression.isReadOnly.

Evaluates the expression relative to the provided context, and returns true if a call to setValue will always fail.

Parameters

context:ELContext: The context of this evaluation.

Returns:boolean

true if the expression is read-only or false if not.

Annotations

@Override

readExternal	back to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException Implements java.io.Externalizable.readExternal. Doc from java.io.Externalizable.readExternal. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal. Parameters in:ObjectInput the stream to read data from in order to restore the object Annotations @Override Exceptions IOException: if I/O errors occur ClassNotFoundException: If the class for an object being restored cannot be found.

readExternal

back to summary

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Implements java.io.Externalizable.readExternal.

Doc from java.io.Externalizable.readExternal.

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Parameters

in:ObjectInput: the stream to read data from in order to restore the object

Annotations

@Override

Exceptions

IOException:: if I/O errors occur
ClassNotFoundException:: If the class for an object being restored cannot be found.

setValue	back to summary
public void setValue(ELContext context, Object value) Implements abstract jakarta.el.ValueExpression.setValue. Doc from jakarta.el.ValueExpression.setValue. Evaluates the expression relative to the provided context, and sets the result to the provided value. Parameters context:ELContext The context of this evaluation. value:Object The new value to be set. Annotations @Override

setValue

back to summary

public void setValue(ELContext context, Object value)

Implements abstract jakarta.el.ValueExpression.setValue.

Doc from jakarta.el.ValueExpression.setValue.

Evaluates the expression relative to the provided context, and sets the result to the provided value.

Parameters

context:ELContext: The context of this evaluation.
value:Object: The new value to be set.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

writeExternal	back to summary
public void writeExternal(ObjectOutput out) throws IOException Implements java.io.Externalizable.writeExternal. Doc from java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays. Parameters out:ObjectOutput the stream to write the object to Annotations @Override Exceptions IOException: Includes any I/O exceptions that may occur

writeExternal

back to summary

public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Doc from java.io.Externalizable.writeExternal.

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Parameters

out:ObjectOutput: the stream to write the object to

Annotations

@Override

Exceptions

IOException:: Includes any I/O exceptions that may occur

public final Class TagValueExpression

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail