spoon.reflect.code.CtYieldStatement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spoon-core Show documentation

Spoon is a tool for meta-programming, analysis and transformation of Java programs.

There is a newer version: 11.1.1-beta-14

/*
 * 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.reflect.code;

import spoon.reflect.annotations.PropertyGetter;
import spoon.reflect.annotations.PropertySetter;

import static spoon.reflect.path.CtRole.EXPRESSION;

/**
 * This code element defines a yield statement.
 *
 * Example:
 *  *     int x = 0;
 *     x = switch ("foo") {
 *         default -> {
 * 					x=x+1;
 * 					yield x; //<--- yield statement
 * 					}
 *     };
 * 
 * A yield statement is implicit in the following example:
 * Example:
 *  *     int x = 0;
 *     x = switch ("foo") {
 *         default -> 4; //<---  implicit yield statement
 *     };
 * 
 * the example wouldn't be allowed without the brackets at the default case,
 * because java syntax defines case -> [expression] or case -> [blockStatement]
 * and yield is not a expression.
 */
public interface CtYieldStatement extends CtCFlowBreak  {
	/**
	 * Gets the expression of the yield statement.
	 * Example: case 1 -> {yield 10};
	 * (This syntax is available as a feature since Java 14)
	 */
	@PropertyGetter(role = EXPRESSION)
	CtExpression getExpression();

	/**
	 * Gets the expression of the yield statement.
	 * Example: case 1 -> {yield 10};
	 * (This syntax is available as a feature since Java 14)
	 */
	@PropertySetter(role = EXPRESSION)
	 T setExpression(CtExpression expression);

	@Override
	CtYieldStatement clone();
}