org.eclipse.ocl.pivot

Interface Comment

All Superinterfaces:

Element, Visitable

All Known Implementing Classes:

CommentImpl

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 Elements
• Body
• Owning Element

See Also:

PivotPackage.getComment()

EMF generated code

Method Summary

Modifier and Type	Method and Description
List<Element>	getAnnotatedElements() Returns the value of the 'Annotated Elements' reference list.
String	getBody() Returns the value of the 'Body' attribute.
Element	getOwningElement() Returns the value of the 'Owning Element' container reference.
void	setBody(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 org.eclipse.ocl.pivot.Element

accept, allOwnedElements, getAnnotatingComments, getESObject, getETarget, getOwnedAnnotations, getOwnedComments, getOwnedExtensions, getValue

Methods inherited from interface org.eclipse.ocl.pivot.util.Visitable

eClass

Method Detail

getAnnotatedElements

List<Element> getAnnotatedElements()

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

Returns:

the value of the 'Annotated Elements' reference list.

See Also:

PivotPackage.getComment_AnnotatedElements(), Element.getAnnotatingComments()

EMF generated code

getBody

String getBody()

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

Returns:

the value of the 'Body' attribute.

See Also:

setBody(String), PivotPackage.getComment_Body()

EMF generated code

setBody

void setBody(String value)

Sets the value of the 'Body' attribute.

Parameters:

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

See Also:

getBody()

EMF generated code

getOwningElement

Element getOwningElement()

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

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), PivotPackage.getComment_OwningElement(), Element.getOwnedComments()

EMF generated code

setOwningElement

void setOwningElement(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()

EMF generated code