examples/org.eclipse.ocl.examples.codegen/src/org/eclipse/ocl/examples/codegen/java/Iteration2Java.java

/*******************************************************************************
 * Copyright (c) 2013, 2018 CEA LIST and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v20.html
 * 
 * Contributors:
 *   E.D.Willink(CEA LIST) - Initial API and implementation
 *******************************************************************************/
package org.eclipse.ocl.examples.codegen.java;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.ocl.examples.codegen.cgmodel.CGBuiltInIterationCallExp;
import org.eclipse.ocl.examples.codegen.generator.IterationHelper;

public interface Iteration2Java extends IterationHelper
{
	void appendAccumulatorInit(@NonNull JavaStream js, @NonNull CGBuiltInIterationCallExp cgIterationCallExp);
	
	/**
	 * Append the code to assign the final value to the result.
	 * <p>
	 * Returns true if control flow continues into a break, false if terminated by a throw.
	 */
	boolean appendFinalValue(@NonNull JavaStream js, @NonNull CGBuiltInIterationCallExp cgIterationCallExp);
	
	/**
	 * Append the code to update the accumulator
	 * <p>
	 * Returns true if control flow continues to loop again, false if terminated by a throw.
	 */
	boolean appendUpdate(@NonNull JavaStream js, @NonNull CGBuiltInIterationCallExp cgIterationCallExp);
}