org.eclipse.uml2.uml.internal.operations.TemplateSignatureOperations Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of uml Show documentation
UML2 UML Model
The newest version!
/*
 * Copyright (c) 2005, 2014 IBM Corporation, CEA, and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   IBM - initial API and implementation
 *   Kenn Hussey (CEA) - 418466
 *
 */
package org.eclipse.uml2.uml.internal.operations;

import java.util.Map;

import org.eclipse.emf.common.util.BasicDiagnostic;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.DiagnosticChain;

import org.eclipse.uml2.uml.TemplateSignature;

import org.eclipse.uml2.uml.util.UMLValidator;

/**
 * 
 * A static utility class that provides operations related to 'Template Signature' model objects.
 * 
 *
 * 
 * The following operations are supported:
 * 

 *   {@link org.eclipse.uml2.uml.TemplateSignature#validateOwnElements(org.eclipse.emf.common.util.DiagnosticChain, java.util.Map) Validate Own Elements}
 *   {@link org.eclipse.uml2.uml.TemplateSignature#validateUniqueParameters(org.eclipse.emf.common.util.DiagnosticChain, java.util.Map) Validate Unique Parameters}
 * 
 * 
 *
 * @generated
 */
public class TemplateSignatureOperations
		extends ElementOperations {

	/**
	 * 
	 * 
	 * @generated
	 */
	protected TemplateSignatureOperations() {
		super();
	}

	/**
	 * 
	 * 
	 * 
	 * Parameters must own the ParameterableElements they parameter or those ParameterableElements must be owned by the TemplateableElement being templated.
	 * template.ownedElement->includesAll(parameter.parameteredElement->asSet() - parameter.ownedParameteredElement->asSet())
	 * @param templateSignature The receiving 'Template Signature' model object.
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @generated
	 */
	public static boolean validateOwnElements(
			TemplateSignature templateSignature, DiagnosticChain diagnostics,
			Map context) {
		// TODO: implement this method
		// -> specify the condition that violates the invariant
		// -> verify the details of the diagnostic, including severity and message
		// Ensure that you remove @generated or mark it @generated NOT
		if (false) {
			if (diagnostics != null) {
				diagnostics
					.add(new BasicDiagnostic(
						Diagnostic.ERROR,
						UMLValidator.DIAGNOSTIC_SOURCE,
						UMLValidator.TEMPLATE_SIGNATURE__OWN_ELEMENTS,
						org.eclipse.emf.ecore.plugin.EcorePlugin.INSTANCE
							.getString(
								"_UI_GenericInvariant_diagnostic", new Object[]{"validateOwnElements", org.eclipse.emf.ecore.util.EObjectValidator.getObjectLabel(templateSignature, context)}), //$NON-NLS-1$ //$NON-NLS-2$
						new Object[]{templateSignature}));
			}
			return false;
		}
		return true;
	}

	/**
	 * 
	 * 
	 * 
	 * The names of the parameters of a TemplateSignature are unique.
	 * parameter->forAll( p1, p2 | (p1 <> p2 and p1.parameteredElement.oclIsKindOf(NamedElement) and p2.parameteredElement.oclIsKindOf(NamedElement) ) implies
	 *    p1.parameteredElement.oclAsType(NamedElement).name <> p2.parameteredElement.oclAsType(NamedElement).name)
	 * @param templateSignature The receiving 'Template Signature' model object.
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @generated
	 */
	public static boolean validateUniqueParameters(
			TemplateSignature templateSignature, DiagnosticChain diagnostics,
			Map context) {
		// TODO: implement this method
		// -> specify the condition that violates the invariant
		// -> verify the details of the diagnostic, including severity and message
		// Ensure that you remove @generated or mark it @generated NOT
		if (false) {
			if (diagnostics != null) {
				diagnostics
					.add(new BasicDiagnostic(
						Diagnostic.ERROR,
						UMLValidator.DIAGNOSTIC_SOURCE,
						UMLValidator.TEMPLATE_SIGNATURE__UNIQUE_PARAMETERS,
						org.eclipse.emf.ecore.plugin.EcorePlugin.INSTANCE
							.getString(
								"_UI_GenericInvariant_diagnostic", new Object[]{"validateUniqueParameters", org.eclipse.emf.ecore.util.EObjectValidator.getObjectLabel(templateSignature, context)}), //$NON-NLS-1$ //$NON-NLS-2$
						new Object[]{templateSignature}));
			}
			return false;
		}
		return true;
	}

} // TemplateSignatureOperations