Immutability

A property delegate to create thread safe immutable frozen properties backed by AtomicReference. The property can be declared with by [Immutability] (initialValue) keyword. All get and set operations are then performed atomically. Note that the values are immutable once set. So any updates to the internal properties of the value will cause a failure.

This is really useful if you want an immutable object so that it can be shared among different threads with some dynamic behavior (like lazy initialization)

Examples

// Since top level objects are always immutable, they can be accessed from any thread.
object SharedObject{

val person: Person? by Immutability<Person?>(initialValue = null)

  fun initialize(p: Person) { // any thread can now atomically update the person property.
    person = p // will succeed
    person.name = ""  // will cause error
  }
}

class MyClass {
  val value: Int by Immutability<Int>(initialValue = 0)
}

// can be called from any thread as long as instance is thread shareable.
instance.value = 3