EnhancedForStatementBuilder.java

/**
 * Optimus, framework for Model Transformation
 *
 * Copyright (C) 2013 Worldline or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License.
 *
 * This library 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 GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
package net.atos.optimus.m2m.javaxmi.operation.instructions.builders.complex;

import org.eclipse.gmt.modisco.java.EnhancedForStatement;
import org.eclipse.gmt.modisco.java.Expression;
import org.eclipse.gmt.modisco.java.SingleVariableDeclaration;
import org.eclipse.gmt.modisco.java.Statement;
import org.eclipse.gmt.modisco.java.emf.JavaFactory;

/**
 * A builder dedicated to create enhanced for statement of modisco model
 * 
 * @author tnachtergaele <nachtergaele.thomas@gmail.com>
 * 
 *
 */

public class EnhancedForStatementBuilder {

	/** The build enhanced for statement */
	private EnhancedForStatement buildEnhancedForStatement;

	/**
	 * Give an enhanced for statement builder
	 * 
	 * @return a new enhanced for statement builder.
	 */
	public static EnhancedForStatementBuilder builder() {
		return new EnhancedForStatementBuilder();
	}

	/**
	 * Private constructor
	 * 
	 */
	private EnhancedForStatementBuilder() {
		this.buildEnhancedForStatement = JavaFactory.eINSTANCE.createEnhancedForStatement();
	}

	/**
	 * Build an enhanced for statement of modisco model
	 * 
	 * @return a new enhanced for statement of modisco model.
	 */
	public EnhancedForStatement build() {
		return this.buildEnhancedForStatement;
	}

	/**
	 * Set the body of the enhanced for statement under construction
	 * 
	 * @param body
	 *            the body of the enhanced for statement under construction.
	 * @return the builder.
	 */
	public EnhancedForStatementBuilder setBody(Statement body) {
		this.buildEnhancedForStatement.setBody(body);
		return this;
	}

	/**
	 * Set the expression of the enhanced for statement under construction
	 * 
	 * @param expression
	 *            the expression of the enhanced for statement under
	 *            construction.
	 * @return the builder.
	 */
	public EnhancedForStatementBuilder setExpression(Expression expression) {
		this.buildEnhancedForStatement.setExpression(expression);
		return this;
	}

	/**
	 * Set the parameter of the enhanced for statement under construction
	 * 
	 * @param parameter
	 *            the parameter of the enhanced for statement under
	 *            construction.
	 * @return the builder.
	 */
	public EnhancedForStatementBuilder setParameter(SingleVariableDeclaration parameter) {
		this.buildEnhancedForStatement.setParameter(parameter);
		return this;
	}

}