AgeConnectionTerminator.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.graphics.internal;

import java.util.Objects;

import org.osate.ge.graphics.ConnectionTerminator;

/**
 * Describes a terminator that is shown at the end of a connection.
 */
public class AgeConnectionTerminator implements ConnectionTerminator {
	/**
	 * The terminator's type. Determines the shape of the terminator.
	 */
	public final ConnectionTerminatorType type;

	/**
	 * The terminator's size
	 */
	public final ConnectionTerminatorSize size;

	/**
	 * Whether the terminator should "point" in the opposite direction. For horizontal lines, this will  cause the shape
	 * to be mirrored in the X axis
	 */
	public final boolean reversed;

	/**
	 * Creates a new instance with the specified fields values.
	 * @param type the value for the {@link #type} field
	 * @param size the value for the {@link #size} field
	 * @param reversed the value for the {@link #reversed} field
	 */
	public AgeConnectionTerminator(final ConnectionTerminatorType type, final ConnectionTerminatorSize size, final boolean reversed) {
		this.type = Objects.requireNonNull(type, "type must not be null");
		this.size = Objects.requireNonNull(size, "size must not be null");
		this.reversed = reversed;
	}
}