glok-model/uk.co.nickthecoder.glok.collections/ObservableList

ObservableList

interface ObservableList<out E> : List<E> , Observable

A list, which can be observed by ListChangeListeners and InvalidationListeners.

Note, the collection names in Glok use Kotlin's naming convention. So an ObservableList is not mutable, whereas MutableObservableList is mutable.

Comparing Glok with JavaFX :

Glok : ObservableList -> JavaFX : ReadOnlyObservableList
Glok : MutableObservableList -> JavaFX : ObservableList

Class Diagram

                                            ╭╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╮
                       ╭╌╌╌╌╌╌╌╌╌╌╌╮        ┆    Observable    ┆           ╭╌╌╌╌╌╌╌╌╌╌╌╌╌╮
┌─────────────────────▶┆   List    ┆        ┆ addListener()    ┆           ┆ObservableInt┆
│                      ╰╌╌╌╌╌╌╌╌╌╌╌╯        ┆ removeListener() ┆           ╰╌╌╌╌╌╌╌╌╌╌╌╌╌╯
│                            △              ╰╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╯                  △
│                            │                        △                           │
│                ┌───────────┴──────────────────┐     │                           │
│                │                       ╭╌╌╌╌╌╌┴╌╌╌╌╌┴╌╌╌╌╌╌╌╌╌╌╮       ┏━━━━━━━━┷━━━━━━━━━┓
│           ╭╌╌╌╌┴╌╌╌╌╌╌╮                ┆    ObservableList     ┆       ┃ObservableListSize┃
│  ┌───────▶┆MutableList┆                ┆ addChangeListener()   ┆◀──────┨                  ┃
│  │        ╰╌╌╌╌╌╌╌╌╌╌╌╯                ┆ removeChangeListener()┆       ┃                  ┃
│  │             △                       ╰╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╯       ┗━━━━━━━━━━━━━━━━━━┛
│  │             │                                    △
│  │             │                                    │
│  │             │      ┌─────────────────────────────┴──┬─────────────────────────────┐
│  │             │      │                                │                             │
│  │  ╭╌╌╌╌╌╌╌╌╌╌┴╌╌╌╌╌╌┴╌╌╌╮            ┏━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━┓     ┏━━━━━━━━━┷━━━━━━━━━┓
│  │  ┆MutableObservableList┆            ┃ReadOnlyObservableListWrapper┃     ┃EmptyObservableList┃
│  │  ┆                     ┆            ┃  actual : List              ┃     ┃                   ┃
│  │  ┆                     ┆            ┃                             ┃     ┗━━━━━━━━━━━━━━━━━━━┛
│  │  ╰╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╯            ┃                             ┠────────────────────┐
│  │             △                       ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛                    │
│  │             │                                                                          │
│  │             │                                                                          │
│  │ ┏━━━━━━━━━━━┷━━━━━━━━━━━━━━━━┓   ┌──────────────────────────┐ ┌───────────────────┐    │
│  │ ┃MutableObservableListWrapper┃   │    ListChangeListener    │ │    ListChange     │    │
│  └─┨  actual : MutableList      ┃◇──┤                          │ │ from : Int        │    │
│    ┃                            ┃   │ changed(List)│ │ added : List      │    │
│    ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛   └──────────────────────────┘ │ removed : List    │    │
│                                                                  │ isAddition()      │    │
│                                                                  │ isRemoval()       │    │
│                                                                  │ isReplacement()   │    │
│                                                                  └───────────────────┘    │
│                                                                                           │
└───────────────────────────────────────────────────────────────────────────────────────────┘

Created with Blokart