Instruction.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;

import net.atos.optimus.m2m.javaxmi.operation.accesses.TypeAccessHelper;
import net.atos.optimus.m2m.javaxmi.operation.elements.Element;
import net.atos.optimus.m2m.javaxmi.operation.instructions.builders.ExpressionStatementBuilder;
import net.atos.optimus.m2m.javaxmi.operation.instructions.builders.ReturnStatementBuilder;
import net.atos.optimus.m2m.javaxmi.operation.instructions.builders.elementary.CastExpressionBuilder;
import net.atos.optimus.m2m.javaxmi.operation.instructions.builders.elementary.InstanceOfExpressionBuilder;
import net.atos.optimus.m2m.javaxmi.operation.instructions.builders.elementary.ParenthesizedExpressionBuilder;
import net.atos.optimus.m2m.javaxmi.operation.instructions.complex.ComplexInstruction;
import net.atos.optimus.m2m.javaxmi.operation.instructions.complex.IComplexInstruction;
import net.atos.optimus.m2m.javaxmi.operation.instructions.elementary.ElementaryInstruction;
import net.atos.optimus.m2m.javaxmi.operation.instructions.elementary.IElementaryInstruction;

import org.eclipse.gmt.modisco.java.Expression;
import org.eclipse.gmt.modisco.java.ExpressionStatement;
import org.eclipse.gmt.modisco.java.PostfixExpression;
import org.eclipse.gmt.modisco.java.PrefixExpression;
import org.eclipse.gmt.modisco.java.Statement;
import org.eclipse.gmt.modisco.java.SuperConstructorInvocation;

/**
 * Models an instruction : wrapper of ExpressionStatement in modisco model
 * 
 * @author tnachtergaele <nachtergaele.thomas@gmail.com>
 * 
 *
 */

public class Instruction extends Element<Statement> implements IElementaryInstruction, IComplexInstruction {

	/** The expression */
	private Expression expression;

	/**
	 * Constructor of instruction
	 * 
	 * @param statement
	 *            the expression statement.
	 */
	public Instruction(ExpressionStatement statement) {
		super(statement);
		this.expression = statement.getExpression();
	}

	/**
	 * Constructor of instruction
	 * 
	 * @param statement
	 *            the super constructor invocation statement.
	 */
	public Instruction(SuperConstructorInvocation statement) {
		super(statement);
		this.expression = statement.getExpression();
	}

	/**
	 * Constructor of instruction
	 * 
	 * @param postfixExpression
	 *            the postfix expression.
	 */
	public Instruction(PostfixExpression postfixExpression) {
		super(ExpressionStatementBuilder.builder().setExpression(postfixExpression).build());
		this.expression = postfixExpression;
	}

	/**
	 * Constructor of instruction
	 * 
	 * @param prefixExpression
	 *            the prefix expression.
	 */
	public Instruction(PrefixExpression prefixExpression) {
		super(ExpressionStatementBuilder.builder().setExpression(prefixExpression).build());
		this.expression = prefixExpression;
	}

	public Statement getStatement() {
		return this.getDelegate();
	}

	public Expression getExpression() {
		return this.expression;
	}

	@Override
	public Instruction addJavadoc(String documentation, boolean addEmptyLine) {
		super.addJavadoc(documentation, addEmptyLine);
		return this;
	}

	@Override
	public Instruction addComment(String commentText, boolean prefixOfParent) {
		super.addComment(commentText, prefixOfParent);
		return this;
	}

	@Override
	public ElementaryInstruction withParentheses() {
		return new ElementaryInstruction(ParenthesizedExpressionBuilder.builder().setExpression(this.getExpression())
				.build());
	}

	@Override
	public ComplexInstruction convertToReturnInstruction() {
		return new ComplexInstruction(ReturnStatementBuilder.builder().setExpression(this.getExpression()).build());
	}

	@Override
	public ElementaryInstruction convertToCastInstruction(String castName) {
		return new ElementaryInstruction(CastExpressionBuilder.builder().setExpression(this.getExpression())
				.setType(TypeAccessHelper.createTypeAccess(castName)).build());
	}

	@Override
	public ElementaryInstruction convertToInstanceOfInstruction(String typeName) {
		return new ElementaryInstruction(InstanceOfExpressionBuilder.builder().setLeftOperand(this.getExpression())
				.setRightOperand(TypeAccessHelper.createTypeAccess(typeName)).build());
	}

}