CtCodeSnippetStatement.java

/**
 * Copyright (C) 2006-2017 INRIA and contributors
 * Spoon - http://spoon.gforge.inria.fr/
 *
 * This software is governed by the CeCILL-C License under French law and
 * abiding by the rules of distribution of free software. You can use, modify
 * and/or redistribute the software under the terms of the CeCILL-C license as
 * circulated by CEA, CNRS and INRIA at http://www.cecill.info.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the CeCILL-C License for more details.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C license and that you accept its terms.
 */
package spoon.reflect.code;

import spoon.reflect.declaration.CtCodeSnippet;
import spoon.reflect.reference.CtTypeReference;
import spoon.support.compiler.SnippetCompilationError;

/**
 * This element is a code snippet that must represent a statement and can thus
 * be inserted in the program's model as is. Code snippets should be avoided
 * since no controls can be performed on them.
 */

public interface CtCodeSnippetStatement extends CtStatement, CtCodeSnippet {

	/**
	 * Compiles this statement code snippet to produce the corresponding AST
	 * statement.
	 *
	 * If you want to compile a non-void return or a snippet that uses a non-void  return,
	 * use, {@link spoon.support.compiler.SnippetCompilationHelper#compileStatement(CtCodeSnippetStatement, CtTypeReference)}
	 *
	 * @return a statement
	 * @throws SnippetCompilationError
	 * 		when the current snippet is not valid Java code
	 */
	<S extends CtStatement> S compile() throws SnippetCompilationError;

	@Override
	CtCodeSnippetStatement clone();
}