ModelModificationStep.java

/**
 * Copyright (c) 2004-2025 Carnegie Mellon University and others. (see Contributors file).
 * All Rights Reserved.
 *
 * NO WARRANTY. ALL MATERIAL IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY
 * KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE
 * OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT
 * MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
 *
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 * SPDX-License-Identifier: EPL-2.0
 *
 * Created, in part, with funding and support from the United States Government. (see Acknowledgments file).
 *
 * This program includes and/or can make use of certain third party source code, object code, documentation and other
 * files ("Third Party Software"). The Third Party Software that is used by this program is dependent upon your system
 * configuration. By using this program, You agree to comply with any and all relevant Third Party Software terms and
 * conditions contained in any such Third Party Software or separate license file distributed with such Third Party
 * Software. The parties who own the Third Party Software ("Third Party Licensors") are intended third party benefici-
 * aries to this license with respect to the terms applicable to their Third Party Software. Third Party Software li-
 * censes only apply to the Third Party Software and not any other portion of this program or this program as a whole.
 */
package org.osate.ge.internal.operations;

import java.util.Objects;

import org.eclipse.emf.ecore.EObject;
import org.osate.ge.operations.ModelModifier;
import org.osate.ge.operations.OperationBuilder.BusinessObjectToModifyProvider;

/**
 * A step which modifies the model
 *
 * @param <T> the type of the tag to use when modifying the model
 * @param <B> the type of the business object being modified
 * @param <P> the type of the user value of the result of the previous step
 * @param <R> the type of the user value of the new step's result
 */
public class ModelModificationStep<T, B extends EObject, P, R>
extends AbstractStep {
	private final T tag;
	private final BusinessObjectToModifyProvider<T, B, P> boProvider;
	private final ModelModifier<T, B, P, R> modifier;

	/**
	 * Creates a new instance
	 * @param nextStep the next step in the sequence
	 * @param tag the tag to use during modification
	 * @param boProvider the provider which will return the business object to modify
	 * @param modifier the object which will perform the modification
	 */
	public ModelModificationStep(final Step nextStep, final T tag,
			final BusinessObjectToModifyProvider<T, B, P> boProvider,
			final ModelModifier<T, B, P, R> modifier) {
		super(nextStep);
		this.tag = tag;
		this.boProvider = Objects.requireNonNull(boProvider, "boProvider must not be null");
		this.modifier = Objects.requireNonNull(modifier, "modifier must not be null");
	}

	/**
	 * The tag to use when modifying the model
	 * @return the tag to use when modifying the model
	 * @see BusinessObjectToModifyProvider
	 */
	public final T getTag() {
		return tag;
	}

	/**
	 * The provider which will return the business object model
	 * @return the provider which will return the business object model.
	 */
	public final BusinessObjectToModifyProvider<T, B, P> getBusinessObjectProvider() {
		return boProvider;
	}

	/**
	 * The object which will perform the modification
	 * @return the object which will perform the modification
	 * @see ModelModifier
	 */
	public final ModelModifier<T, B, P, R> getModifier() {
		return modifier;
	}
}