spoon.template

Class ExpressionTemplate<T>

java.lang.Object

spoon.template.ExpressionTemplate<T>

All Implemented Interfaces:

Template, TemplateParameter<T>

public abstract class ExpressionTemplate<T>
extends Object
implements TemplateParameter<T>, Template

This class represents an expression template parameter expressed in Java.

To define a new expression template parameter, you must subclass this class and implement the expression() method, which actually defines the Java expression. It corresponds to a CtExpression.

Constructor Summary

Constructors

Constructor and Description
ExpressionTemplate() Creates a new expression template parameter.

Method Summary

Methods

Modifier and Type	Method and Description
abstract T	expression() This method must be implemented to define the template expression.
static <T> CtExpression<T>	getExpression(CtClass<? extends ExpressionTemplate<?>> p) Returns the expression.
CtExpression<T>	getSubstitution(CtSimpleType<?> targetType) Returns the code which must be substituted to this template parameter, depending on its value.
T	S() Gets the type of the template parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpressionTemplate

public ExpressionTemplate()

Creates a new expression template parameter.

Method Detail

getExpression

public static <T> CtExpression<T> getExpression(CtClass<? extends ExpressionTemplate<?>> p)

Returns the expression.

expression

public abstract T expression()
                      throws Throwable

This method must be implemented to define the template expression. The convention is that the defined expression corresponds to the expression returned by the return statement of the method.

Throws:

Throwable

getSubstitution

public CtExpression<T> getSubstitution(CtSimpleType<?> targetType)

Description copied from interface: TemplateParameter

Returns the code which must be substituted to this template parameter, depending on its value.

Specified by:

getSubstitution in interface TemplateParameter<T>

Parameters:

targetType - the type that defines the context of the substitution (for reference redirection).

S

public T S()

Description copied from interface: TemplateParameter

Gets the type of the template parameter. This methods has no runtime meaning (should return a null reference) but is used as a marker in a template code. When generating a template code, each invocation of this method will be substituted with the result of the TemplateParameter.getSubstitution(CtSimpleType) method.

Specified by:

S in interface TemplateParameter<T>