spoon.template.Template Maven / Gradle / Ivy
Show all versions of spoon-core Show documentation
/*
* SPDX-License-Identifier: (MIT OR CECILL-C)
*
* Copyright (C) 2006-2023 INRIA and contributors
*
* Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) or the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
*/
package spoon.template;
import spoon.reflect.declaration.CtElement;
import spoon.reflect.declaration.CtType;
/**
*
* A template code is simply a piece of code that uses a
* {@link TemplateParameter}'s instance. It must then invoke the
* {@link TemplateParameter#S()} method.
*
*
* When the template parameter is a String it is used to rename element of the code such as fields or methods.
* When it is another primitive type (or a boxing
* type) representing a literal, or a Class, the template parameter can be
* directly accessed. To use a standard parameter containing a String type, use a CtLiteral<String>
*
*
* import spoon.template.Template;
* import spoon.template.Value;
*
* public class SimpleTemplate implements Template {
* // template parameter fields
* \@Parameter String _parameter_;
*
* \@Parameter CtLiteral<String> _anotherParameter;
*
*
* // parameters binding
* \@Local
* public SimpleTemplate(String parameter, CtLiteral<String> anotherParameter) {
* _parameter_ = parameter;
* _anotherParameter = anotherParameter;
* }
*
* // template method
* public void methodwith_parameter_() {
* System.out.println(_anotherParameter);
* }
* }
*
*
*
* The template parameters must be bound to their values in the template's
* constructor (which should be defined as a template's
* {@link spoon.template.Local}. A possible use of a template would be to
* insert the template into a target class, by using
* {@link Substitution#insertAll(CtType, Template)}:
*
*
* spoon.reflect.CtClass target=...;
* CtLiteral<String> anotherParameter = factory.createLiteral();
* anotherParameter.setValue("hello templated world");
*
* Template template=new SimpleTemplate("ParameterizedName", anotherParameter);
* Substitution.insertAll(target,template);
*
*
*
* If the target class is an empty class named A, the resulting
* code will be:
*
*
* public class A {
* public void methodwithParameterizedName() {
* System.out.println("hello templated world");
* }
* }
*
*/
public interface Template {
/**
* Returns the code which results from applying the template.
*
* @param targetType
* the type that defines the context of the substitution.
* It may be null for templates with no context.
*/
T apply(CtType targetType);
/** if true, the result of the template evaluation is simplified with partial evaluation */
boolean withPartialEvaluation();
}