PortSideUtil.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.layout;

import org.eclipse.elk.core.options.PortSide;
import org.osate.ge.internal.diagram.runtime.DockArea;

import com.google.common.collect.BiMap;
import com.google.common.collect.ImmutableBiMap;

/**
 * Utility class for converting between ELK {@link PortSide} and {@link DockArea}
 *
 */
public final class PortSideUtil {
	/**
	 * Private constructor to prevent instantiation.
	 */
	public PortSideUtil() {
	}

	private final static BiMap<DockArea, PortSide> DOCK_AREA_TO_PORT_SIDE_MAP = ImmutableBiMap.of(DockArea.TOP,
			PortSide.NORTH, DockArea.BOTTOM, PortSide.SOUTH, DockArea.LEFT, PortSide.WEST, DockArea.RIGHT,
			PortSide.EAST);

	/**
	 * Retrieves the {@link PortSide} for the specified {@link DockArea}
	 * @param dockArea the dock area to convert
	 * @return the port side
	 * @throws IllegalArgumentException if the dock area could not be converted
	 */
	public static PortSide getPortSideForNonGroupDockArea(final DockArea dockArea) {
		final PortSide portSide = DOCK_AREA_TO_PORT_SIDE_MAP.get(dockArea);
		if (portSide == null) {
			throw new IllegalArgumentException("Unexpected dock area: " + dockArea);
		}

		return portSide;
	}

	/**
	 * Returns the {@link DockArea} for the specified {@link PortSide}
	 * @param ps the port side for which to return the dock area
	 * @return the dock area. Returns null if the value could not be found.
	 */
	public static DockArea getDockArea(final PortSide ps) {
		return DOCK_AREA_TO_PORT_SIDE_MAP.inverse().get(ps);
	}
}