PaletteCommandUtil.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.aadl2.ui;

import org.eclipse.core.resources.IProject;
import org.osate.aadl2.AadlPackage;
import org.osate.aadl2.Classifier;
import org.osate.aadl2.ComponentClassifier;
import org.osate.aadl2.ComponentImplementation;
import org.osate.ge.palette.PaletteCommandProviderContext;

/**
 * Utility class for implementing palette command providers and palette commands.
 *
 * Contains methods for checking what AADL model elements could potentially be in a diagram. These methods are useful for limiting the palette
 * commands to diagrams for which they may be used. Since the palette is populated when the diagram is opened, it is populated based on what
 * elements could potentially appear on the diagram. This is determined based on the diagram business object in the {@link PaletteCommandProviderContext}
 * provided to the {@link org.osate.ge.palette.PaletteContributor}.
 *
 * @since 2.0
 */
public final class PaletteCommandUtil {
	/**
	 * Private constructor to prevent instantiation.
	 */
	private PaletteCommandUtil() {
	}

	/**
	 * Determines whether AADL packages or classifiers could potentially be shown on the diagram.
	 * @param ctx the context which provides the diagram business object
	 * @return whether AADL packages or classifiers could potentially be shown on the diagram.
	 */
	public static boolean diagramMayContainPackageOrClassifiers(final PaletteCommandProviderContext ctx) {
		final Object diagramBo = ctx.getDiagramBusinessObject();
		return diagramBo instanceof IProject || diagramBo instanceof AadlPackage || diagramBo instanceof Classifier;
	}

	/**
	 * Determines whether AADL packages or component classifiers could potentially be shown on the diagram.
	 * @param ctx the context which provides the diagram business object
	 * @return whether AADL packages or component classifiers could potentially be shown on the diagram.
	 */
	public static boolean diagramMayContainPackageOrComponentClassifiers(final PaletteCommandProviderContext ctx) {
		final Object diagramBo = ctx.getDiagramBusinessObject();
		return diagramBo instanceof IProject || diagramBo instanceof AadlPackage
				|| diagramBo instanceof ComponentClassifier;
	}

	/**
	 * Determines whether AADL packages or component implementations could potentially be shown on the diagram.
	 * @param ctx the context which provides the diagram business object
	 * @return whether AADL packages or component implementations could potentially be shown on the diagram.
	 */
	public static boolean diagramMayContainPackageOrComponentImplementations(final PaletteCommandProviderContext ctx) {
		final Object diagramBo = ctx.getDiagramBusinessObject();
		return diagramBo instanceof IProject || diagramBo instanceof AadlPackage
				|| diagramBo instanceof ComponentImplementation;
	}

	/**
	 * Determines whether AADL packages could potentially be shown on the diagram.
	 * @param ctx the context which provides the diagram business object
	 * @return whether AADL packages could potentially be shown on the diagram.
	 */
	public static boolean diagramMayContainPackage(final PaletteCommandProviderContext ctx) {
		final Object diagramBo = ctx.getDiagramBusinessObject();
		return diagramBo instanceof IProject || diagramBo instanceof AadlPackage;
	}
}