Package io.opencaesar.oml

Interface Annotation

All Superinterfaces:

Element, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

AnnotationImpl

public interface Annotation
extends Element

A representation of the model object 'Annotation'. Annotation is an element that specifies additional non-semantic information on an annotated element. It can also be specified on a reference to an ontology member, in which case it is interpreted as if it was specified on the member itself. An annotation is specified with an annotation property and an optional literal or reference value. When no value is specified, it is interpreted as a boolean `true` literal.

The following features are supported:

• Property
• Value
• Reference Value
• Owning Element
• Owning Reference

See Also:

• OmlPackage.getAnnotation()

Generated:

Model:

annotation="https://tabatkins.github.io/bikeshed heading='Elements'"

Method Summary

Modifier and Type	Method	Description
AnnotatedElement	getOwningElement()	Returns the value of the 'Owning Element' container reference.
Reference	getOwningReference()	Returns the value of the 'Owning Reference' container reference.
AnnotationProperty	getProperty()	Returns the value of the 'Property' reference.
Member	getReferenceValue()	Returns the value of the 'Reference Value' reference.
Literal	getValue()	Returns the value of the 'Value' containment reference.
void	setOwningElement(AnnotatedElement value)	Sets the value of the 'Owning Element' container reference.
void	setOwningReference(Reference value)	Sets the value of the 'Owning Reference' container reference.
void	setProperty(AnnotationProperty value)	Sets the value of the 'Property' reference.
void	setReferenceValue(Member value)	Sets the value of the 'Reference Value' reference.
void	setValue(Literal value)	Sets the value of the 'Value' containment reference.

Methods inherited from interface io.opencaesar.oml.Element

extraValidate, getOntology

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 org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Details

getProperty

AnnotationProperty getProperty()

Returns the value of the 'Property' reference. The annotation property specified by this annotation

Returns:

the value of the 'Property' reference.

See Also:

• setProperty(AnnotationProperty)
• OmlPackage.getAnnotation_Property()

Generated:

Model:

required="true"

setProperty

void setProperty(AnnotationProperty value)

Sets the value of the 'Property' reference.

Parameters:

value - the new value of the 'Property' reference.

See Also:

• getProperty()

Generated:

getValue

Literal getValue()

Returns the value of the 'Value' containment reference. The literal value specified by this annotation.

Returns:

the value of the 'Value' containment reference.

See Also:

• setValue(Literal)
• OmlPackage.getAnnotation_Value()

Generated:

Model:

containment="true"

setValue

void setValue(Literal value)

Sets the value of the 'Value' containment reference.

Parameters:

value - the new value of the 'Value' containment reference.

See Also:

• getValue()

Generated:

getReferenceValue

Member getReferenceValue()

Returns the value of the 'Reference Value' reference. The reference value (to a member) specified by this annotation

Returns:

the value of the 'Reference Value' reference.

See Also:

• setReferenceValue(Member)
• OmlPackage.getAnnotation_ReferenceValue()

Generated:

Model:

setReferenceValue

void setReferenceValue(Member value)

Sets the value of the 'Reference Value' reference.

Parameters:

value - the new value of the 'Reference Value' reference.

See Also:

• getReferenceValue()

Generated:

getOwningElement

AnnotatedElement getOwningElement()

Returns the value of the 'Owning Element' container reference. It is bidirectional and its opposite is 'Owned Annotations'. The annotated element that owns this annotation

Returns:

the value of the 'Owning Element' container reference.

See Also:

• setOwningElement(AnnotatedElement)
• OmlPackage.getAnnotation_OwningElement()
• AnnotatedElement.getOwnedAnnotations()

Generated:

Model:

opposite="ownedAnnotations" transient="false"

setOwningElement

void setOwningElement(AnnotatedElement 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:

getOwningReference

Reference getOwningReference()

Returns the value of the 'Owning Reference' container reference. It is bidirectional and its opposite is 'Owned Annotations'. The reference that owns this annotation

Returns:

the value of the 'Owning Reference' container reference.

See Also:

• setOwningReference(Reference)
• OmlPackage.getAnnotation_OwningReference()
• Reference.getOwnedAnnotations()

Generated:

Model:

opposite="ownedAnnotations" transient="false"

setOwningReference

void setOwningReference(Reference value)

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

Parameters:

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

See Also:

• getOwningReference()

Generated: