EnumerationLiteral interface

An EnumerationLiteral is a user-defined data value for an Enumeration.

Inheritance Hierarchy

EnumerationLiteral NamedElement Element
EnumerationLiteral OrderedElement Element

Attributes

NameTypeDescription
appliedStereotypesStereotype [0..*]Indicates which stereotypes from the selected profile (or profiles) are applied to the element. The selected profiles are the profiles that are applied to the containing package. Inherited from Element.
enumerationEnumeration Gets the enumeration that owns this enumeration literal. This property is derived. 
idstring Gets the unique ID of the element. Inherited from Element.
namestring The name of the NamedElement. Inherited from NamedElement.
orderinteger [1..1]Gets or set the sort order of the element if it is part of a collection. The value is 0 for elements to which no particular ordering applies. Elements with a lower order come before elements with a higher order. Inherited from OrderedElement.
ownedCommentsComment [0..*]The Comments owned by this Element. Inherited from Element.
ownerElement [0..1]Gets the element that owns this element. Inherited from Element.
specificationValueSpecification [1..1] 
taggedValuesTaggedValueSpecification [0..*]Contains 0 or more tagged values for the element. Inherited from Element.
visibilityVisibilityKind [0..1]Determines whether and how the NamedElement is visible outside its owning Namespace. Inherited from NamedElement.

Operations

NameReturnsDescription
getFirstCommentBody()

EnumerationLiteral.getFirstCommentBody

X

Gets the text contents of the first comment in the element's owned comments, or an empty string if the element has no comments.

Return value
Type: string [1..1]
The body string of the first comment. If the element has no comments, an empty string is returned.
string [1..1]Gets the text contents of the first comment in the element's owned comments, or an empty string if the element has no comments. Inherited from Element.
getSpecificationValue()

EnumerationLiteral.getSpecificationValue

X

Gets the value of the Specification property.

Return value
Type: object [0..1]
The default value (the type depending on the type of value), or null if no default value can be determined.
object [0..1]Gets the value of the Specification property.