CtReturn.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.template.TemplateParameter;

/**
 * This code element represents a <code>return</code> statement.
 *
 * Example:
 * <pre>
 *    Runnable r = new Runnable() {
 *     	@Override
 *     	public void run() {
 *     	  return; // <-- CtReturn statement
 *     	}
 *    };
 * </pre>

 */
public interface CtReturn<R> extends CtCFlowBreak, TemplateParameter<Void> {

	/**
	 * Gets the returned expression.
	 */
	CtExpression<R> getReturnedExpression();

	/**
	 * Sets the returned expression.
	 */
	<T extends CtReturn<R>> T setReturnedExpression(CtExpression<R> returnedExpression);

	@Override
	CtReturn<R> clone();
}