org.eclipse.uml2
Interface Comment

All Superinterfaces:
Element, EModelElement, EObject, Notifier, TemplateableElement

public interface Comment
extends TemplateableElement

A representation of the model object 'Comment'. A comment gives the ability to attach various remarks to elements. A comment carries no semantic force, but may contain information that is useful to a modeler. A comment can be owned by any element.

The following features are supported:

See Also:
UML2Package.getComment()

Field Summary
static String copyright
           
 
Method Summary
 StringExpression createBodyExpression(EClass eClass)
          Creates a StringExpression and sets the 'Body Expression' containment reference
 EList getAnnotatedElements()
          Returns the value of the 'Annotated Element' reference list.
 String getBody()
          Returns the value of the 'Body' attribute.
 StringExpression getBodyExpression()
          Returns the value of the 'Body Expression' containment reference
 EList getOwnedElements()
           
 void setBody(String value)
          Sets the value of the 'Body' attribute
 void setBodyExpression(StringExpression value)
          Sets the value of the 'Body Expression' containment reference
 
Methods inherited from interface org.eclipse.uml2.TemplateableElement
createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwner, getValue, hasKeyword, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, validateHasOwner, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getBody

public String getBody()
Returns the value of the 'Body' attribute. The default value is "".

If the meaning of the 'Body' attribute isn't clear, there really should be more of a description here...

Specifies a string that is the comment.

Returns:
the value of the 'Body' attribute.
See Also:
setBody(String), UML2Package.getComment_Body()

setBody

public void setBody(String value)
Sets the value of the 'Body' attribute.

Parameters:
value - the new value of the 'Body' attribute.
See Also:
getBody()

getAnnotatedElements

public EList getAnnotatedElements()
Returns the value of the 'Annotated Element' reference list. The list contents are of type Element.

If the meaning of the 'Annotated Element' reference list isn't clear, there really should be more of a description here...

References the Element(s) being commented.

Returns:
the value of the 'Annotated Element' reference list.
See Also:
UML2Package.getComment_AnnotatedElement()

getBodyExpression

public StringExpression getBodyExpression()
Returns the value of the 'Body Expression' containment reference.

If the meaning of the 'Body Expression' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Body Expression' containment reference.
See Also:
setBodyExpression(StringExpression), UML2Package.getComment_BodyExpression()

setBodyExpression

public void setBodyExpression(StringExpression value)
Sets the value of the 'Body Expression' containment reference.

Parameters:
value - the new value of the 'Body Expression' containment reference.
See Also:
getBodyExpression()

createBodyExpression

public StringExpression createBodyExpression(EClass eClass)
Creates a StringExpression and sets the 'Body Expression' containment reference.

Parameters:
eClass - The Ecore class of the StringExpression to create.
Returns:
The new StringExpression.
See Also:
getBodyExpression()

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface TemplateableElement

Copyright 2003, 2004 IBM Corporation and others.
All Rights Reserved.