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

public final Class TagMethodExpression

extends MethodExpression
implements Externalizable
Class Inheritance
All Implemented Interfaces
java.io.Externalizable, java.io.Serializable
Imports
javax.el.*, javax.faces.view.facelets.TagAttribute, java.io.Externalizable, .IOException, .ObjectInput, .ObjectOutput

Author
Jacob Hookom
Version
$Id$

Field Summary

Modifier and TypeField and Description
private String
private MethodExpression
private static final long

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the Object to test for equality.
o
)

Implements abstract javax.el.Expression.equals.

Determines whether the specified object is equal to this Expression.
public String
getExpressionString()

Implements abstract javax.el.Expression.getExpressionString.

Returns the original String used to create this Expression, unmodified.
public MethodInfo
getMethodInfo(ELContext
The context of this evaluation
context
)

Implements abstract javax.el.MethodExpression.getMethodInfo.

Evaluates the expression relative to the provided context, and returns information about the actual referenced method.
public int
hashCode()

Implements abstract javax.el.Expression.hashCode.

Returns the hash code for this Expression.
public Object
invoke(ELContext
The context of this evaluation.
context
,
Object[]
The parameters to pass to the method, or null if no parameters.
params
)

Implements abstract javax.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 javax.el.Expression.isLiteralText.

Returns whether this expression was created from only literal text.
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 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.
Inherited from javax.el.MethodExpression:
isParametersProvidedisParmetersProvided

Field Detail

attrback to summary
private String attr
origback to summary
private MethodExpression orig
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

TagMethodExpressionback to summary
public TagMethodExpression()
TagMethodExpressionback to summary
public TagMethodExpression(TagAttribute attr, MethodExpression orig)

Method Detail

equalsback to summary
public boolean equals(Object o)

Implements abstract javax.el.Expression.equals.

Doc from javax.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
getExpressionStringback to summary
public String getExpressionString()

Implements abstract javax.el.Expression.getExpressionString.

Doc from javax.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
getMethodInfoback to summary
public MethodInfo getMethodInfo(ELContext context)

Implements abstract javax.el.MethodExpression.getMethodInfo.

Doc from javax.el.MethodExpression.getMethodInfo.

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

Parameters
context:ELContext

The context of this evaluation

Returns:MethodInfo

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

Annotations
@Override
hashCodeback to summary
public int hashCode()

Implements abstract javax.el.Expression.hashCode.

Doc from javax.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
invokeback to summary
public Object invoke(ELContext context, Object[] params)

Implements abstract javax.el.MethodExpression.invoke.

Doc from javax.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 EL 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 isParmetersProvided() is true.

Parameters
context:ELContext

The context of this evaluation.

params: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
isLiteralTextback to summary
public boolean isLiteralText()

Implements abstract javax.el.Expression.isLiteralText.

Doc from javax.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 EL delimeters (${...} or #{...}).

Returns:boolean

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

Annotations
@Override
readExternalback 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.
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
writeExternalback 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