DiagramNodePredicates.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.diagram.runtime;

/**
 * Utility class containing methods related to {@link DiagramNode}
 *
 */
public final class DiagramNodePredicates {
	/**
	 * Private constructor to prevent instantiation.
	 */
	private DiagramNodePredicates() {
	}

	/**
	 * Returns true if the specified diagram not is an instance of {@link AgeDiagram} or if us a {@link DiagramElement} whose graphic is an an
	 * undocked shape.
	 * @param dn the diagram node to check.
	 * @return the result of the predicate.
	 */
	public static boolean isDiagramOrUndockedShape(final DiagramNode dn) {
		if (dn instanceof AgeDiagram) {
			return true;
		} else if (dn instanceof DiagramElement) {
			final DiagramElement dstDiagramElement = (DiagramElement) dn;
			return DiagramElementPredicates.isShape(dstDiagramElement)
					&& DiagramElementPredicates.isUndocked(dstDiagramElement);
		} else {
			return false;
		}
	}

	/**
	 * Returns true if the diagram node is a {@link DiagramElement} whose graphic is a flow indicator
	 * @param dn the diagram node to check
	 * @return true if the diagram node is a {@link DiagramElement} whose graphic is a flow indicator
	 * @see DiagramElementPredicates#isFlowIndicator(DiagramElement)
	 */
	public static boolean isFlowIndicator(final DiagramNode dn) {
		return dn instanceof DiagramElement && DiagramElementPredicates.isFlowIndicator((DiagramElement) dn);
	}
}