PropagationKey.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.combined;

import java.util.Objects;

import org.osate.aadl2.DirectionType;

/**
 * Immutable class representing a combination of a direction and an indicator regarding whether the propagation object
 * is a containment or a propagation. A propagation point can have only one propagation per key.
 *
 */
final class PropagationKey {
	/**
	 * The propagation's direction
	 */
	public final DirectionType direction;

	/**
	 * True if the {@link org.osate.xtext.aadl2.errormodel.errorModel.ErrorPropagation}  is a containment. False if it is a regular propagation.
	 */
	public final boolean isContainment;

	/**
	 * Creates a new instance with the specified values
	 * @param direction the value for {@link #direction}
	 * @param isContainment the value for {@link #isContainment}
	 */
	public PropagationKey(final DirectionType direction, final boolean isContainment) {
		this.direction = direction;
		this.isContainment = isContainment;
	}

	@Override
	public int hashCode() {
		return Objects.hash(direction, isContainment);
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (!(obj instanceof PropagationKey)) {
			return false;
		}
		PropagationKey other = (PropagationKey) obj;
		return direction == other.direction && isContainment == other.isContainment;
	}
}