api/base/src/main/java/org/eclipse/mdm/api/base/model/ContextType.java

/********************************************************************************
 * Copyright (c) 2015-2021 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 ********************************************************************************/

package org.eclipse.mdm.api.base.model;

/**
 * Context type enumeration.
 *
 * @since 1.0.0
 * @author Viktor Stoehr, Gigatronik Ingolstadt GmbH
 * @author Sebastian Dirsch, Gigatronik Ingolstadt GmbH
 * @see ContextRoot
 */
public enum ContextType {

	// ======================================================================
	// Enumerations
	// ======================================================================

	/**
	 * A {@link ContextRoot} of this type unites meta data of the unit under test.
	 */
	UNITUNDERTEST("UnitUnderTest"),

	/**
	 * A {@link ContextRoot} of this type unites meta data of the test conditions.
	 */
	TESTSEQUENCE("TestSequence"),

	/**
	 * A {@link ContextRoot} of this type unites meta data of the used equipment
	 * (hardware and sensors).
	 */
	TESTEQUIPMENT("TestEquipment");

	// ======================================================================
	// Public methods
	// ======================================================================

	private String typeName;

	/**
	 * Default constructor for this enumeration.
	 *
	 * @param typeName the correct type name
	 */
	ContextType(String typeName) {
		this.typeName = typeName;
	}

	/**
	 * Get the correct type name for the {@link ContextType}.
	 *
	 * @return the type name
	 */
	public String typeName() {
		return typeName;
	}

	/**
	 * Returns true if this context type is {@link #UNITUNDERTEST}.
	 *
	 * @return Returns {@code true} if this constant is the constant described
	 *         above.
	 */
	public boolean isUnitUnderTest() {
		return UNITUNDERTEST == this;
	}

	/**
	 * Returns true if this context type is {@link #TESTSEQUENCE}.
	 *
	 * @return Returns {@code true} if this constant is the constant described
	 *         above.
	 */
	public boolean isTestSequence() {
		return TESTSEQUENCE == this;
	}

	/**
	 * Returns true if this context type is {@link #TESTEQUIPMENT}.
	 *
	 * @return Returns {@code true} if this constant is the constant described
	 *         above.
	 */
	public boolean isTestEquipment() {
		return TESTEQUIPMENT == this;
	}

}