BusinessObjectAndExtra.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.operations;

import java.util.Objects;

/**
 * Simple immutable data structure which contains a business object along with an additional data object.
 *
 * @param <B> the type of the business object
 * @param <E> the type of the extra data.
 * @since 2.0
 */
public class BusinessObjectAndExtra<B, E> {
	private final B bo;
	private final E extra;

	/**
	 * Creates a new instance with the specified business object and extra data.
	 * @param bo is the business object. Must not be null.
	 * @param extra may be null
	 */
	public BusinessObjectAndExtra(final B bo, final E extra) {
		this.bo = Objects.requireNonNull(bo, "bo must not be null");
		this.extra = extra;
	}

	@Override
	public int hashCode() {
		return Objects.hash(bo, extra);
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (!(obj instanceof BusinessObjectAndExtra)) {
			return false;
		}
		BusinessObjectAndExtra<?, ?> other = (BusinessObjectAndExtra<?, ?>) obj;
		return Objects.equals(bo, other.bo) && Objects.equals(extra, other.extra);
	}

	/**
	 * Returns the business object. Will never return null.
	 * @return the business object
	 */
	public final B getBusinessObject() {
		return bo;
	}

	/**
	 * Returns the extra data.
	 * @return the extra data.
	 */
	public final E getExtra() {
		return extra;
	}
}