org.eclipse.uml2.uml.Comment Maven / Gradle / Ivy

Go to download
/*
 * 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) - 327039, 418466
 *   Christian W. Damus (CEA) - 251963
 *
 */
package org.eclipse.uml2.uml;

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

/**
 * 
 * A representation of the model object 'Comment'.
 * 
 *
 * 
 * A Comment is a textual annotation that can be attached to a set of Elements.
 * From package UML::CommonStructure.
 * 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.eclipse.uml2.uml.Comment#getAnnotatedElements Annotated Element}
 *   {@link org.eclipse.uml2.uml.Comment#getBody Body}
 * 
 * 
 *
 * @see org.eclipse.uml2.uml.UMLPackage#getComment()
 * @model
 * @generated
 */
public interface Comment
		extends Element {

	/**
	 * Returns the value of the 'Body' attribute.
	 * 
	 * 
	 * 
	 * Specifies a string that is the comment.
	 * From package UML::CommonStructure.
	 * 
	 * @return the value of the 'Body' attribute.
	 * @see #isSetBody()
	 * @see #unsetBody()
	 * @see #setBody(String)
	 * @see org.eclipse.uml2.uml.UMLPackage#getComment_Body()
	 * @model unsettable="true" dataType="org.eclipse.uml2.types.String" ordered="false"
	 *        extendedMetaData="kind='element'"
	 * @generated
	 */
	String getBody();

	/**
	 * Sets the value of the '{@link org.eclipse.uml2.uml.Comment#getBody Body}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Body' attribute.
	 * @see #isSetBody()
	 * @see #unsetBody()
	 * @see #getBody()
	 * @generated
	 */
	void setBody(String value);

	/**
	 * Unsets the value of the '{@link org.eclipse.uml2.uml.Comment#getBody Body}' attribute.
	 * 
	 * 
	 * @see #isSetBody()
	 * @see #getBody()
	 * @see #setBody(String)
	 * @generated
	 */
	void unsetBody();

	/**
	 * Returns whether the value of the '{@link org.eclipse.uml2.uml.Comment#getBody Body}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Body' attribute is set.
	 * @see #unsetBody()
	 * @see #getBody()
	 * @see #setBody(String)
	 * @generated
	 */
	boolean isSetBody();

	/**
	 * Returns the value of the 'Annotated Element' reference list.
	 * The list contents are of type {@link org.eclipse.uml2.uml.Element}.
	 * 
	 * 
	 * 
	 * References the Element(s) being commented.
	 * From package UML::CommonStructure.
	 * 
	 * @return the value of the 'Annotated Element' reference list.
	 * @see org.eclipse.uml2.uml.UMLPackage#getComment_AnnotatedElement()
	 * @model ordered="false"
	 * @generated
	 */
	EList getAnnotatedElements();

} // Comment