FaultSource.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.ui.swt;

import org.osate.xtext.aadl2.errormodel.errorModel.ErrorBehaviorState;
import org.osate.xtext.aadl2.errormodel.errorModel.TypeSet;

/**
 * Represents a fault source. The referenced type set and behavior state should be treated as immutable.
 */
public final class FaultSource {
	private final ErrorBehaviorState errorBehaviorState;
	private final TypeSet errorTypeSet;
	private final String failureModeDescription;

	/**
	 * Creates a new instance with every field set to null
	 */
	public FaultSource() {
		this.errorBehaviorState = null;
		this.errorTypeSet = null;
		this.failureModeDescription = null;
	}

	/**
	 * Creates a new instance with the specified field values. Other fields are set to null.
	 * @param errorBehaviorState the error behavior state value. See {@link #getErrorBehaviorState()}
	 * @param errorTypeSet the error type set. See {@link #getErrorTypeSet()}
	 */
	public FaultSource(final ErrorBehaviorState errorBehaviorState,
			final TypeSet errorTypeSet) {
		this.errorBehaviorState = errorBehaviorState;
		this.errorTypeSet = errorTypeSet;
		this.failureModeDescription = null;
	}

	/**
	 * Creates a new instance with the specified field values. Other fields are set to null.
	 * @param failureModeDescription the failure mode description value. See {@link #getFailureModeDescription()}
	 */
	public FaultSource(final String failureModeDescription) {
		this.errorBehaviorState = null;
		this.errorTypeSet = null;
		this.failureModeDescription = failureModeDescription;
	}

	/**
	 * Returns the fault source's error behavior state
	 * @return the error behavior state
	 * @see org.osate.xtext.aadl2.errormodel.errorModel.ErrorSource#getFailureModeReference()
	 */
	public final ErrorBehaviorState getErrorBehaviorState() {
		return errorBehaviorState;
	}

	/**
	 * Returns the fault source's error type set
	 * @return the error type set
	 * @see org.osate.xtext.aadl2.errormodel.errorModel.ErrorSource#getFailureModeType()
	 */
	public final TypeSet getErrorTypeSet() {
		return errorTypeSet;
	}

	/**
	 * Returns the fault source's failure mode description
	 * @return the failure mode description
	 * @see org.osate.xtext.aadl2.errormodel.errorModel.ErrorSource#getFailureModeDescription()
	 */
	public final String getFailureModeDescription() {
		return failureModeDescription;
	}
}