Umple API Summary
User Manual [Previous] [Next]
API Summary
The following table describes the API generated from various Umple features. This is designed as a quick reference. To find the exact API for any system that would be generated in Java, use UmpleOnline and request to generate JavaDoc output.
| Summary of the API generated by Umple from attributes, associations, state machines and other features | ||||||||||||
| API GENERATED IN ALL CASES | ||||||||||||
| void delete() | removes object, correctly handling cascade deletion and referential integrity | |||||||||||
| any methods in the code are emitted as-is; they are made public if this is not declared | ||||||||||||
| API GENERATED FROM ATTRIBUTES | ||||||||||||
| T is the type of the attribute (String if omitted); note that Umple builtin types such as Integer become native types such as int | ||||||||||||
| z is the attribute name | ||||||||||||
| Note that the API for array attributes is shown as a column in the associations table further down | ||||||||||||
| Umple concept | basic | initialized | lazy | defaulted | lazy immutable | immutable | autounique | constant | internal | key | ||
| Umple notation | T z; | T z = val; | lazy T z; | defaulted T z = val; | lazy immutable T z; | immutable z; | autounique z | const T z=val | internal T z; | key { z } | ||
| Querying value | ||||||||||||
| T getZ() | return the value | yes | yes | yes | yes | yes | yes | yes; T always int | depends | |||
| boolean isZ() | return true if value is true | if T Boolean | if T Boolean | if T Boolean | if T Boolean | if T Boolean | if T Boolean | depends | ||||
| boolean equals(Object) | is equal to another? | yes | ||||||||||
| Mutating | ||||||||||||
| boolean setZ(T) | mutates the attribute | yes | yes | yes | yes | yes; true only once | depends | |||||
| boolean resetZ() | restores original default | yes | ||||||||||
| Other | ||||||||||||
| T getDefaultZ() | returns original default | yes | ||||||||||
| int hashCode() | Likely unique value | yes | ||||||||||
| constructor args | T | T | ||||||||||
| initial value | constructor val | val | null/0/false | val | null/0/false | constructor val or val | next int | static val | construtor val | |||
| API GENERATED FROM ASSOCIATIONS | ||||||||||||
| X is the name of current class | ||||||||||||
| W is the name of the class at the other end of the association; used in method names unless a role name is present; pluralization rules are applied | ||||||||||||
| r is a role name used when referring to W (optional, except in reflexive associations) | ||||||||||||
| Umple concept | ? To many | ? To many with role | optional | ? To one | required many | directional | immutable | immutable optional | reflexive | symmetric reflexive | array attribute | |
| Umple notation | -- * W; | -- * W r; | -- 0..1 W; | -- 1 W; | -- 1..* W; | -> 1--* W; | immutable 1 -> * W; | immutable 1 -> 0..1 W; | * -- * X r; | * self r; | W [] r; | |
| Querying link(s) | ||||||||||||
| W getW() | return the W | yes; W or null | yes | W or null | ||||||||
| W getW(index) | pick a specific linked W | yes | yes; getR(index) | yes | yes | yes | R and X | R | yes; getR(index) | |||
| List<W> getWs() | ges immutable list of links | yes | yes; getR() | yes | yes | yes | R and Xs | yes; W[] getR() | ||||
| boolean hasWs() | is cardinality > 0? | yes | yes; hasR() | yes | yes | yes | R and Xs | R | yes; hasR() | |||
| int indexOfW(W) | look up specific W -1 if none | yes | yes; … ofR(W) | yes | yes | yes | R and X | R | yes; … ofR(W) | |||
| int numberOfWs() | cardinality | yes | yes; … ofR() | yes | yes | yes | R and Xs | R | yes; … ofR() | |||
| Mutating | ||||||||||||
| boolean setW(W) | add a link to existing W | yes | if * -- or 0..1 -- | never | never | |||||||
| W addW(args) | construct a new W and adds link | if 1 -- * W | if 1 -- * W r | never | never | |||||||
| boolean addW(W) | add a link to existing W | yes | yes; addR(W) | yes | yes | never | never | R and X | R | yes; addR(W) | ||
| boolean setWs(W…) | add a set of links | yes | yes | never | never | |||||||
| boolean removeW(W) | remove link to W if possible | yes | yes; removeR(W) | yes | yes | never | never | R and Xs | R | yes; removeR(W) | ||
| Other | ||||||||||||
| static int minimumNumberOfWs() | multiplicity lower bound | yes | yes; … ofR() | yes | yes | yes | R and Xs | R | ||||
| static int maximumNumberOfWs() | multiplicity upper bound if > 1 | |||||||||||
| static int requiredNumberOfWs() | fixed multiplicity if > 1 | |||||||||||
| boolean isNumberOfWsValid() | false if breaching constraints | yes; true initially | ||||||||||
| constructor args | W (W args if 1 -- 1) | W … | W | |||||||||
| initial value | empty | empty | empty | constructor val | empty | empty | constructor val | constructor val | empty | empty | empty | |
| API GENGERATED FROM STATE MACHINES | ||||||||||||
| sm is the name of the state machine | ||||||||||||
| Umple concept | Sm with events | Enum with no events | ||||||||||
| enum getSm() | current state for statemachine sm | yes | yes | |||||||||
| String getSmFullName() | current state for statemachine sm | yes | yes | |||||||||
| enum getSmS2() | state of substate s2 | yes | ||||||||||
| boolean e() | event method e (for all events) | yes | yes | |||||||||
| boolean setSm(enum) | set state directly | yes | ||||||||||
| Substates allowed | yes | |||||||||||
| initial value | first state listed | |||||||||||
| API GENERATED FROM SINGLETON | ||||||||||||
| static X getInstance() | ||||||||||||