org.eclipse.uml2.uml.ValuePin 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
There is a newer version: 5.0.0-v20140602-0749
/*
 * Copyright (c) 2005, 2011 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) - 327039
 *
 * $Id: ValuePin.java,v 1.7 2007/04/25 17:47:06 khussey Exp $
 */
package org.eclipse.uml2.uml;

import java.util.Map;

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

import org.eclipse.emf.ecore.EClass;

/**
 * 
 * A representation of the model object 'Value Pin'.
 * 
 *
 * 
 * A value pin is an input pin that provides a value by evaluating a value specification.
 * 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.eclipse.uml2.uml.ValuePin#getValue Value}
 * 
 * 
 *
 * @see org.eclipse.uml2.uml.UMLPackage#getValuePin()
 * @model
 * @generated
 */
public interface ValuePin
		extends InputPin {

	/**
	 * Returns the value of the 'Value' containment reference.
	 * 
	 * This feature subsets the following features:
	 * 

	 *   '{@link org.eclipse.uml2.uml.Element#getOwnedElements() Owned Element}'
	 * 
	 * 
	 * 
	 * 
	 * 
	 * Value that the pin will provide.
	 * 
	 * @return the value of the 'Value' containment reference.
	 * @see #setValue(ValueSpecification)
	 * @see org.eclipse.uml2.uml.UMLPackage#getValuePin_Value()
	 * @model containment="true" resolveProxies="true" required="true" ordered="false"
	 * @generated
	 */
	ValueSpecification getValue();

	/**
	 * Sets the value of the '{@link org.eclipse.uml2.uml.ValuePin#getValue Value}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Value' containment reference.
	 * @see #getValue()
	 * @generated
	 */
	void setValue(ValueSpecification value);

	/**
	 * Creates a new {@link org.eclipse.uml2.uml.ValueSpecification}, with the specified 'Name', and 'Type', and sets the 'Value' containment reference.
	 * 
	 * 
	 * @param name The 'Name' for the new {@link org.eclipse.uml2.uml.ValueSpecification}, or null.
	 * @param type The 'Type' for the new {@link org.eclipse.uml2.uml.ValueSpecification}, or null.
	 * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.ValueSpecification} to create.
	 * @return The new {@link org.eclipse.uml2.uml.ValueSpecification}.
	 * @see #getValue()
	 * @generated
	 */
	ValueSpecification createValue(String name, Type type, EClass eClass);

	/**
	 * 
	 * 
	 * 
	 * The type of value specification must be compatible with the type of the value pin.
	 * true
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @model
	 * @generated
	 */
	boolean validateCompatibleType(DiagnosticChain diagnostics,
			Map context);

	/**
	 * 
	 * 
	 * 
	 * Value pins have no incoming edges.
	 * true
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @model
	 * @generated
	 */
	boolean validateNoIncomingEdges(DiagnosticChain diagnostics,
			Map context);

} // ValuePin