Package com.nomagic.uml2.ext.magicdraw.classes.mdkernel

Interface Comment

All Superinterfaces:

BaseElement, java.lang.Cloneable, java.lang.Comparable, Element, org.eclipse.emf.ecore.EObject, MDObject, ModelObject, org.eclipse.emf.common.notify.Notifier, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject

public interface Comment
extends Element

A representation of the model object 'Comment'.

A Comment is a textual annotation that can be attached to a set of Elements.

The following features are supported:

• Annotated Element
• Body
• Owning Element

See Also:

UMLPackage.getComment()

Model:

annotation="MOF package='classes.mdkernel'"

Generated:

Method Summary

Modifier and Type	Method	Description
java.util.Collection<Element>	getAnnotatedElement()	Returns the value of the 'Annotated Element' reference list.
java.lang.String	getBody()	Returns the value of the 'Body' attribute.
Element	getOwningElement()	Returns the value of the 'Owning Element' container reference.
boolean	hasAnnotatedElement()
void	setBody(java.lang.String value)	Sets the value of the 'Body' attribute.
void	setOwningElement(Element value)	Sets the value of the 'Owning Element' container reference.

Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement

accept, addPropertyChangeListener, atInsert, canAdd, canAdd, canAddChild, canAddInstance, canBeDeleted, canChangeParent, canDeleteChild, clone, dispose, firePropertyChange, getClassType, getHumanName, getHumanType, getObjectParent, isEditable, isParentOf, removeAllPropertyChangeListeners, removePropertyChangeListener, sGetID

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element

get_activityPartitionOfRepresents, get_commentOfAnnotatedElement, get_constraintOfConstrainedElement, get_diagramOfContext, get_directedRelationshipOfSource, get_directedRelationshipOfTarget, get_elementOfSyncElement, get_elementTaggedValue, get_elementValueOfElement, get_relationshipOfRelatedElement, getAppliedStereotype, getOwnedComment, getOwnedElement, getOwner, getSyncElement, getTaggedValue, has_activityPartitionOfRepresents, has_commentOfAnnotatedElement, has_constraintOfConstrainedElement, has_diagramOfContext, has_directedRelationshipOfSource, has_directedRelationshipOfTarget, has_elementOfSyncElement, has_elementValueOfElement, has_relationshipOfRelatedElement, hasAppliedStereotype, hasElementTaggedValue, hasOwnedComment, hasOwnedElement, hasTaggedValue, setOwner, setSyncElement

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface com.nomagic.magicdraw.foundation.MDObject

getID, getMDExtension, getMdExtensions, setID

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.base.ModelObject

get_representationText, getLocalID, ignoringRefGetValue, isInvalid, set_representationText, setLocalID, sGetLocalID

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Method Detail

getAnnotatedElement

java.util.Collection<Element> getAnnotatedElement()

Returns the value of the 'Annotated Element' reference list. The list contents are of type Element. It is bidirectional and its opposite is 'comment Of Annotated Element'. References the Element(s) being commented.

Returns:

the value of the 'Annotated Element' reference list.

See Also:

UMLPackage.getComment_AnnotatedElement(), Element.get_commentOfAnnotatedElement()

Model:

opposite="_commentOfAnnotatedElement" ordered="false"

Generated:

getBody

@CheckForNull
java.lang.String getBody()

Returns the value of the 'Body' attribute. The default value is "". Specifies a string that is the comment.

Returns:

the value of the 'Body' attribute.

See Also:

setBody(String), UMLPackage.getComment_Body()

Model:

default="" dataType="com.nomagic.uml2.ext.magicdraw.String" ordered="false"

Generated:

setBody

void setBody(@CheckForNull
             java.lang.String value)

Sets the value of the 'Body' attribute.

Parameters:

value - the new value of the 'Body' attribute.

See Also:

getBody()

Generated:

getOwningElement

@CheckForNull
Element getOwningElement()

Returns the value of the 'Owning Element' container reference. It is bidirectional and its opposite is 'Owned Comment'.

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

Returns:

the value of the 'Owning Element' container reference.

See Also:

setOwningElement(Element), UMLPackage.getComment_OwningElement(), Element.getOwnedComment()

Model:

opposite="ownedComment" transient="false" ordered="false"

Generated:

setOwningElement

void setOwningElement(@CheckForNull
                      Element value)

Sets the value of the 'Owning Element' container reference.

Parameters:

value - the new value of the 'Owning Element' container reference.

See Also:

getOwningElement()

Generated:

hasAnnotatedElement

boolean hasAnnotatedElement()
                     throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated: