IncrementalLayoutMode.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 java.util.Optional;

/**
 * Different types of incremental layouts
 *
 */
public enum IncrementalLayoutMode {
	/**
	 * Layout entire diagram
	 */
	LAYOUT_DIAGRAM("org.osate.ge.layout.incremental.mode.diagram"),
	/**
	 * Layout container of elements that need to be laid out
	 */
	LAYOUT_CONTAINER(
			"org.osate.ge.layout.incremental.mode.container"),
	/**
	 * Layout contents of elements that need to be laid out
	 */
	LAYOUT_CONTENTS(
			"org.osate.ge.layout.incremental.mode.contents");

	/**
	 * Unique ID for the layout mode. Used to selected mode as a preference
	 */
	public final String id;

	IncrementalLayoutMode(final String id) {
		this.id = id;
	}

	/**
	 * Returns the layout mode with the specified ID
	 * @param id the ID of the mode to retrieve
	 * @return the layout mode with the specified ID. Returns an empty value if the mode could not be found.
	 */
	public static Optional<IncrementalLayoutMode> getById(final String id) {
		for (final IncrementalLayoutMode mode : IncrementalLayoutMode.values()) {
			if (mode.id.equals(id)) {
				return Optional.of(mode);
			}
		}

		return Optional.empty();
	}
}