StarUML API

Modules (50)

UML

Description

Variables Summary

Mixins Summary

Classes Summary

Variables

Public API

ACK_OPAQUE

UMLActionKind

Public API

AK_NONE

UMLAggregationKind

Public API

CCK_SEQUENTIAL

UMLCallConcurrencyKind

Public API

DK_IN

UMLDirectionKind

Public API

EK_SIGNAL

UMLEventKind

Public API

IOK_ALT

UMLInteractionOperatorKind

Public API

MS_SYNCHCALL

UMLMessageSort

Public API

ONOK_UNORDERED

UMLObjectNodeOrderingKind

Public API

PSK_INITIAL

UMLPseudostateKind

Public API

SD_NONE

Stereotype Display

Public API

TK_EXTERNAL

UMLTransitionKind

Public API

VK_PUBLIC

UMLVisibilityKind

Mixins

Object

UMLElementMixin

UMLElementMixin
Methods

Methods

getDisplayClassName

Get class name for display

Returns: string
memberof
UMLElementMixin

getNamespaceString

Get namespace string

Returns: string
memberof
UMLElementMixin

getStereotypeString

Get stereotype string

Returns: string
memberof
UMLElementMixin

getString

Get string representation of this element

includeVisibility boolean
Returns: string
memberof
UMLElementMixin

getTagStringArray

Return an array of tag strings

Returns: Array.<string>
memberof
UMLElementMixin

getVisibilityString

Get visibility string

Returns: string
memberof
UMLElementMixin

Classes

Constructor

UMLModelElement

(extends ExtensibleModel)
(mixes UMLElementMixin)

UMLModelElement
Properties
Methods

Properties

stereotype

Type: UMLStereotype

templateParameters

Type: Array.<UMLTemplateParameter>

visibility

Type: string

Methods

getConstraints

Get constraints of this element

Returns: Array.<UMLConstraint>

getDependants

Get dependants

Returns: Array.<Element>

getDependencies

Get dependencies

Returns: Array.<Element>
Constructor

UMLConstraint

(extends UMLModelElement)

UMLConstraint
Properties

Properties

constrainedElements

Type: Array.<UMLModelElement>

specification

Type: string
Constructor

UMLTemplateParameter

(extends UMLModelElement)

UMLTemplateParameter
Properties

Properties

defaultValue

Type: string

parameterType

Type: string
Constructor

UMLFeature

(extends UMLModelElement)

UMLFeature
Properties

Properties

isLeaf

Type: boolean

isStatic

Type: boolean
Constructor

UMLStructuralFeature

(extends UMLFeature)

UMLStructuralFeature
Properties
Methods

Properties

defaultValue

Type: string

isOrdered

Type: boolean

isReadOnly

Type: boolean

isUnique

Type: boolean

multiplicity

Type: string

type

Type: string

Methods

getTypeString

Get type string

Returns: string
Constructor

UMLParameter

UMLParameter
Properties
Methods

Properties

direction

Type: string

Methods

getDirectionString

Get parameter direction string

Returns: string
Constructor

UMLBehavioralFeature

(extends UMLFeature)

UMLBehavioralFeature
Properties
Methods

Properties

concurrency

Type: string

parameters

Type: Array.<UMLParameter>

raisedExceptions

Type: Array.<UMLSignal>

Methods

getNonReturnParameters

Get non-return parameters

Returns: Array.<UMLParameter>

getParametersString

Get parameters string

Returns: string

getReturnParameter

Get return parameter(s)

Returns: UMLParameter

getReturnString

Get return parameter string

Returns: string
Constructor

UMLAttribute

UMLAttribute
Properties

Properties

aggregation

Type: string

isDerived

Type: string

isID

Type: boolean
Constructor

UMLOperation

UMLOperation
Properties

Properties

bodyConditions

Type: Array.<UMLConstraint>

isAbstract

Type: boolean

isQuery

Type: boolean

postconditions

Type: Array.<UMLConstraint>

preconditions

Type: Array.<UMLConstraint>

specification

Type: string
Constructor

UMLClassifier

(extends UMLModelElement)

UMLClassifier
Properties
Methods

Properties

attributes

Type: Array.<UMLAttribute>

behaviors

Type: Array.<UMLBehavior>

isAbstract

Type: boolean

isFinalSpecialization

Type: boolean

isLeaf

Type: boolean

operations

Type: Array.<UMLOperation>

Methods

getAncestors

Get ancestors

Returns: Array.<Element>

getAssociationEnds

Get all association ends linked to this element

counterpart boolean
Returns whether counterpart (opposite-side) association ends or not.
Returns: Array.<UMLAssociationEnd>

getComponents

Get all components of this element is realizing

Returns: Array.<UMLComponent>

getDeploymentTargets

Get all interfaces of this element is realizing

Returns: Array.<Element>

getDescendants

Get descendants

Returns: Array.<Element>

getGeneralElements

Get general elements

Returns: Array.<Element>

getInheritedAttributes

Get all inherited attributes

Returns: Array.<UMLAttribute>

getInheritedOperations

Get all inherited operations

Returns: Array.<UMLOperation>

getInterfaces

Get all interfaces of this element is realizing

Returns: Array.<UMLInterface>

getSpecialElements

Get special elements

Returns: Array.<Element>

isAncestor

Check a given element is an ancestor of this element

elem Element
Returns: Array.<Element>

isDescendant

Check a given element is a descendant of this element

elem Element
Returns: Array.<Element>

isGeneralElement

Check a given element is a general element of this element

elem Element
Returns: Array.<Element>

isSpecialElement

Check a given element is a special element of this element

elem Element
Returns: Array.<Element>
Constructor

UMLDirectedRelationship

(mixes UMLElementMixin)

UMLDirectedRelationship
Properties

Properties

stereotype

Type: UMLStereotype

visibility

Type: string
Constructor

UMLRelationshipEnd

(extends RelationshipEnd)
(mixes UMLElementMixin)

UMLRelationshipEnd
Properties

Properties

aggregation

Type: string

defaultValue

Type: string

isDerived

Type: boolean

isID

Type: boolean

isOrdered

Type: boolean

isReadOnly

Type: boolean

isUnique

Type: boolean

multiplicity

Type: string

navigable

Type: boolean

stereotype

Type: UMLStereotype

visibility

Type: string
Constructor

UMLUndirectedRelationship

(mixes UMLElementMixin)

UMLUndirectedRelationship
Properties

Properties

stereotype

Type: UMLStereotype

visibility

Type: string
Constructor

UMLBehavior

(extends UMLModelElement)

UMLBehavior
Properties

Properties

isReentrant

Type: boolean

parameters

Type: string

postconditions

Type: string

preconditions

Type: string
Constructor

UMLOpaqueBehavior

(extends UMLBehavior)

UMLOpaqueBehavior
Constructor

UMLEvent

(extends UMLModelElement)

UMLEvent
Properties

Properties

expression

Type: string

kind

Type: string

targetOperation

Type: UMLOperation

targetSignal

Type: UMLSignal

value

Type: string
Constructor

UMLPackage

(extends UMLModelElement)

UMLPackage
Properties

Properties

importedElements

Type: Array.<UMLModelElement>
Constructor

UMLModel

(extends UMLPackage)

UMLModel
Properties

Properties

viewpoint

Type: string
Constructor

UMLClass

(extends UMLClassifier)

UMLClass
Properties

Properties

isActive

Type: boolean
Constructor

UMLInterface

(extends UMLClassifier)

UMLInterface
Methods

Methods

getImplementingClassifiers

Get all implementing classifiers of this interfaces

Returns: Array.<UMLClassifier>
Constructor

UMLSignal

(extends UMLClassifier)

UMLSignal
Constructor

UMLDataType

(extends UMLClassifier)

UMLDataType
Constructor

UMLPrimitiveType

(extends UMLDataType)

UMLPrimitiveType
Constructor

UMLEnumerationLiteral

(extends UMLModelElement)

UMLEnumerationLiteral
Constructor

UMLEnumeration

(extends UMLDataType)

UMLEnumeration
Properties

Properties

literals

Type: Array.<UMLEnumerationLiteral>
Constructor

UMLDependency

UMLDependency
Properties

Properties

mapping

Type: string
Constructor

UMLAbstraction

(extends UMLDependency)

UMLAbstraction
Constructor

UMLRealization

(extends UMLAbstraction)

UMLRealization
Constructor

UMLGeneralization

UMLGeneralization
Properties

Properties

discriminator

Type: string
Constructor

UMLInterfaceRealization

(extends UMLRealization)

UMLInterfaceRealization
Constructor

UMLComponentRealization

(extends UMLRealization)

UMLComponentRealization
Constructor

UMLAssociationEnd

(extends UMLRelationshipEnd)

UMLAssociationEnd
Properties

Properties

qualifiers

Type: Array.<UMLAttribute>
Constructor

UMLAssociation

UMLAssociation
Properties

Properties

end1

Type: UMLAssociationEnd

end2

Type: UMLAssociationEnd

isDerived

Type: boolean
Constructor
(extends UMLModelElement)

UMLAssociationClassLink
Properties

Properties

associationSide

Type: UMLAssociation

classSide

Type: UMLClass
Constructor

UMLSlot

(extends UMLModelElement)

UMLSlot
Properties

Properties

definingFeature

Type: UMLStructuralFeature

value

Type: string
Constructor

UMLInstance

(extends UMLModelElement)

UMLInstance
Properties
Methods

Properties

classifier

Type: UMLClassifier

slots

Type: Array.<UMLSlot>

Methods

getTypeString

Get type string

Returns: string
Constructor

UMLObject

(extends UMLInstance)

UMLObject
Constructor

UMLArtifactInstance

(extends UMLInstance)

UMLArtifactInstance
Constructor

UMLComponentInstance

(extends UMLInstance)

UMLComponentInstance
Constructor

UMLNodeInstance

(extends UMLInstance)

UMLNodeInstance
Constructor

UMLLinkEnd

(extends UMLRelationshipEnd)

UMLLinkEnd
Constructor

UMLLink
Properties

Properties

association

Type: UMLAssociation

end1

Type: UMLLinkEnd

end2

Type: UMLLinkEnd
Constructor

UMLPort

(extends UMLAttribute)

UMLPort
Properties

Properties

isBehavior

Type: boolean

isConjugated

Type: boolean

isService

Type: boolean
Constructor

UMLConnectorEnd

(extends UMLRelationshipEnd)

UMLConnectorEnd
Constructor

UMLConnector

UMLConnector
Properties

Properties

end1

Type: UMLConnectorEnd

end2

Type: UMLConnectorEnd

type

Type: UMLAssociation
Constructor

UMLCollaboration

(extends UMLClassifier)

UMLCollaboration
Constructor

UMLCollaborationUse

(extends UMLModelElement)

UMLCollaborationUse
Properties

Properties

type

Type: UMLCollaboration
Constructor

UMLRoleBinding

(extends UMLDependency)

UMLRoleBinding
Properties

Properties

roleName

Type: string
Constructor

UMLArtifact

(extends UMLClassifier)

UMLArtifact
Properties

Properties

fileName

Type: string
Constructor

UMLComponent

(extends UMLClassifier)

UMLComponent
Properties
Methods

Properties

isIndirectlyInstantiated

Type: boolean

Methods

getRealizingClassifiers

Get all classifier realizing this component

Returns: Array.<UMLClassifier>
Constructor

UMLSubsystem

(extends UMLComponent)

UMLSubsystem
Constructor

UMLNode

(extends UMLClassifier)

UMLNode
Methods

Methods

getDeployedElements

Get all element deployed in this node

Returns: Array.<Element>
Constructor

UMLDeployment

(extends UMLDependency)

UMLDeployment
Constructor

UMLCommunicationPath

(extends UMLAssociation)

UMLCommunicationPath
Constructor

UMLExtensionPoint

(extends UMLModelElement)

UMLExtensionPoint
Properties

Properties

location

Type: string
Constructor

UMLUseCase

(extends UMLClassifier)

UMLUseCase
Properties
Methods

Properties

extensionPoints

Type: Array.<UMLExtensionPoint>

Methods

getActors

Get all actors associated with this use case

Returns: Array.<UMLActor>

getAllIncludedUseCases

Get all included use cases

Returns: Array.<UMLUseCase>

getExtendingUseCases

Get use cases extending this use case

Returns: Array.<UMLUseCase>

getIncludedUseCases

Get use cases directly included in this use case

Returns: Array.<UMLUseCase>
Constructor

UMLActor

(extends UMLClassifier)

UMLActor
Methods

Methods

getUseCases

Get use cases associated with this actor

Returns: Array.<UMLUseCase>
Constructor

UMLInclude

UMLInclude
Constructor

UMLExtend

UMLExtend
Properties

Properties

condition

Type: string

extensionLocations

Type: Array.<UMLExtensionPoint>
Constructor

UMLUseCaseSubject

(extends UMLModelElement)

UMLUseCaseSubject
Properties

Properties

represent

Type: UMLClassifier
Constructor

UMLStateMachine

(extends UMLBehavior)

UMLStateMachine
Properties

Properties

regions

Type: Array.<UMLRegion>
Constructor

UMLRegion

(extends UMLModelElement)

UMLRegion
Properties

Properties

transitions

Type: Array.<UMLTransition>

vertices

Type: Array.<UMLVertex>
Constructor

UMLVertex

(extends UMLModelElement)

UMLVertex
Methods

Methods

getIncomingTransitions

Get incoming transitions

Returns: Array.<UMLTransition>

getOutgoingTransitions

Get outgoing transitions

Returns: Array.<UMLTransition>
Constructor

UMLPseudostate

(extends UMLVertex)

UMLPseudostate
Properties

Properties

kind

Type: string
Constructor

UMLConnectionPointReference

(extends UMLVertex)

UMLConnectionPointReference
Properties

Properties

entry

Type: UMLPseudostate

exit

Type: UMLPseudostate
Constructor

UMLState

(extends UMLVertex)

UMLState
Properties

Properties

connections

Type: UMLConnectionPointReference

doActivities

Type: Array.<UMLBehavior>

entryActivities

Type: Array.<UMLBehavior>

exitActivities

Type: Array.<UMLBehavior>

regions

Type: Array.<UMLRegion>

submachine

Type: UMLStateMachine
Constructor

UMLFinalState

(extends UMLState)

UMLFinalState
Constructor

UMLTransition

UMLTransition
Properties

Properties

effects

Type: Array.<UMLBehavior>

guard

Type: string

kind

Type: string

triggers

Type: Array.<UMLEvent>
Constructor

UMLActivity

(extends UMLActivity)

UMLActivity
Properties

Properties

edges

Type: Array.<UMLActivityEdge>

groups

Type: Array.<UMLActivityGroup>

isReadOnly

Type: boolean

isSingleExecution

Type: boolean

nodes

Type: Array.<UMLActivityNode>
Constructor

UMLPin

UMLPin
Constructor

UMLInputPin

(extends UMLPin)

UMLInputPin
Constructor

UMLOutputPin

(extends UMLPin)

UMLOutputPin
Constructor

UMLActivityNode

(extends UMLModelElement)

UMLActivityNode
Methods

Methods

getIncomingEdges

Get incoming edges

Returns: Array.<UMLActivityEdge>

getOutgoingEdges

Get outgoing edges

Returns: Array.<UMLActivityEdge>
Constructor

UMLAction

(extends UMLActivityNode)

UMLAction
Properties

Properties

body

Type: string

inputs

Type: Array.<UMLInputPin>

isLocallyReentrant

Type: boolean

isSynchronous

Type: boolean

kind

Type: string

language

Type: string

localPostconditions

Type: Array.<UMLConstraint>

localPreconditions

Type: Array.<UMLConstraint>

outputs

Type: Array.<UMLOutputPin>

subactivity

Type: UMLActivity

target

Type: UMLModelElement

triggers

Type: Array.<UMLEvent>
Constructor

UMLObjectNode

(extends UMLActivityNode)

UMLObjectNode
Properties

Properties

isControlType

Type: boolean

ordering

Type: string

type

Type: UMLClassifier
Constructor

UMLControlNode

(extends UMLActivityNode)

UMLControlNode
Constructor

UMLInitialNode

(extends UMLControlNode)

UMLInitialNode
Constructor

UMLFinalNode

(extends UMLControlNode)

UMLFinalNode
Constructor

UMLActivityFinalNode

(extends UMLFinalNode)

UMLActivityFinalNode
Constructor

UMLFlowFinalNode

(extends UMLFinalNode)

UMLFlowFinalNode
Constructor

UMLForkNode

(extends UMLControlNode)

UMLForkNode
Constructor

UMLJoinNode

(extends UMLControlNode)

UMLJoinNode
Constructor

UMLMergeNode

(extends UMLControlNode)

UMLMergeNode
Constructor

UMLDecisionNode

(extends UMLControlNode)

UMLDecisionNode
Constructor

UMLActivityGroup

(extends UMLModelElement)

UMLActivityGroup
Constructor

UMLActivityPartition

(extends UMLActivityGroup)

UMLActivityPartition
Constructor

UMLActivityEdge

UMLActivityEdge
Properties

Properties

guard

Type: string

weight

Type: string
Constructor

UMLControlFlow

(extends UMLActivityEdge)

UMLControlFlow
Constructor

UMLObjectFlow

(extends UMLActivityEdge)

UMLObjectFlow
Constructor

UMLInteractionFragment

(extends UMLBehavior)

UMLInteractionFragment
Constructor

UMLInteraction

UMLInteraction
Properties

Properties

fragments

Type: UMLInteractionFragment

messages

Type: UMLMessage

participants

Type: UMLMessageEndpoint
Constructor

UMLStateInvariant

UMLStateInvariant
Properties

Properties

covered

Type: UMLLifeline

invariant

Type: string
Constructor

UMLContinuation

UMLContinuation
Properties

Properties

setting

Type: boolean
Constructor

UMLInteractionOperand

UMLInteractionOperand
Properties

Properties

guard

Type: string
Constructor

UMLCombinedFragment

UMLCombinedFragment
Properties

Properties

interactionOperator

Type: string

operands

Type: UMLInteractionOperand
Constructor

UMLInteractionUse

UMLInteractionUse
Properties

Properties

refersTo

Type: UMLInteraction

returnValue

Type: string

returnValueRecipient

Type: UMLStructuralFeature
Constructor

UMLMessageEndpoint

(extends UMLModelElement)

UMLMessageEndpoint
Constructor

UMLLifeline

(extends UMLMessageEndpoint)

UMLLifeline
Properties

Properties

isMultiInstance

Type: boolean

represent

Type: UMLStructuralFeature

selector

Type: string
Constructor

UMLGate

(extends UMLMessageEndpoint)

UMLGate
Constructor

UMLEndpoint

(extends UMLMessageEndpoint)

UMLEndpoint
Constructor

UMLMessage

UMLMessage
Properties

Properties

assignmentTarget

Type: string

connector

Type: UMLConnector

messageSort

Type: string

signature

Type: UMLOperation
Constructor

UMLProfile

(extends UMLPackage)

UMLProfile
Constructor

UMLImage

(extends UMLModelElement)

UMLImage
Properties

Properties

content

Type: string

height

Type: number

width

Type: number
Constructor

UMLStereotype

(extends UMLClass)

UMLStereotype
Properties

Properties

icon

Type: UMLImage
Constructor

UMLMetaClass

(extends UMLModelElement)

UMLMetaClass
Constructor

UMLExtension

UMLExtension