CreateEventPaletteCommand.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.errormodel.ui.palette;

import java.util.Optional;

import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.osate.ge.StringUtil;
import org.osate.ge.errormodel.util.ErrorModelNamingUtil;
import org.osate.ge.operations.Operation;
import org.osate.ge.operations.StepResultBuilder;
import org.osate.ge.palette.BasePaletteCommand;
import org.osate.ge.palette.GetTargetedOperationContext;
import org.osate.ge.palette.TargetedPaletteCommand;
import org.osate.xtext.aadl2.errormodel.errorModel.ErrorBehaviorEvent;
import org.osate.xtext.aadl2.errormodel.errorModel.ErrorBehaviorStateMachine;

/**
 * Palette command for creating elements which are subtypes of {@link ErrorBehaviorEvent}.
 */
public class CreateEventPaletteCommand extends BasePaletteCommand implements TargetedPaletteCommand {
	private final EClass eventType;

	/**
	 * Creates a new instance which will create an instance of the specified {@link ErrorBehaviorEvent} subtype
	 * @param eventType the type of event to created. This event must be a subtype of {@link ErrorBehaviorEvent}
	 */
	public CreateEventPaletteCommand(final EClass eventType) {
		super(StringUtil.camelCaseToUser(eventType.getName()), ErrorModelPaletteCategories.ERROR_BEHAVIOR, null);
		this.eventType = eventType;
	}

	@Override
	public Optional<Operation> getOperation(final GetTargetedOperationContext ctx) {
		return Operation.createSimple(ctx.getTarget(), ErrorBehaviorStateMachine.class, stateMachine -> {
			final ErrorBehaviorEvent newEvent = (ErrorBehaviorEvent) EcoreUtil.create(eventType);
			final String newEventName = ErrorModelNamingUtil.buildUniqueIdentifier(stateMachine, "new_event");
			newEvent.setName(newEventName);

			// Add the new event to the state machine
			stateMachine.getEvents().add(newEvent);

			return StepResultBuilder.create().showNewBusinessObject(ctx.getTarget(), newEvent).build();
		});
	}
}