Skip to main content

Object Lifecycle

The object lifecycle represents the different states an object can go through during its existence. The lifecycle is managed by several methods that control the transitions between states and ensure the object's integrity. Here's a summary of the object lifecycle and the role of each method:

Core Objects​

  • Function
  • Bundle
  • Proxy
  • Dictionary

States​

  • Uninitialized: The initial state of an object when it is created but not yet initialized.
  • Building: The state where the object is being constructed, and its member variables are being set.
  • Built: The state where the object is fully constructed and ready for use.
  • Locked: The state where the object is locked and cannot be modified.

Methods​

  1. startBuilding()
    • Transitions the object from the Uninitialized or Built state to the Building state.
    • Called when the object's member variables need to be modified.
    • Allows the object to be modified even if it was previously in the Built state.
  2. finishBuilding()
    • Attempts to transition the object from the Building state to the Built state.
    • Called after the object's member variables have been modified.
    • Checks if all the member variables are in a valid state.
      • If successful, transitions the object to the Built state.
      • If unsuccessful, outputs a warning and keeps the object in the Building state.
  3. lock()
    • Transitions the object from the Built state to the Locked state.
    • Prevents any further modifications to the object.

Diagram​

stateDiagram-v2
    state Uninitialized
    state Building
    state Built
    state Locked
    state try <<choice>>
    Uninitialized --> Building: startBuilding()
    Building --> Building: startBuilding()
    Building --> try: finishBuilding()
    try --> Built: success
    try --> Building: failure
    Built --> Locked: lock()
    Built --> Building: startBuilding()

    classDef uninitialized fill:#FFD700,color:#333
    classDef building fill:#FFA500,color:#333
    classDef built fill:#7FFF00,color:#333
    classDef locked fill:#87CEEB,color:#333
    class Uninitialized uninitialized
    class Building building
    class Built built
    class Locked locked