Provide another type of callback to the ObservableProperty which is called after the property value has been changed.

#KT-6866 Fixed
This commit is contained in:
Ilya Gorbunov
2015-06-22 17:55:48 +03:00
parent 61e657567d
commit 9dbc4e4eef
2 changed files with 39 additions and 16 deletions
@@ -36,24 +36,24 @@ public object Delegates {
/**
* Returns a property delegate for a read/write property that calls a specified callback function when changed.
* @param initial the initial value of the property.
* @param onChange the callback which is called when the property value is changed.
* @param onChange the callback which is called after the change of the property is made. The value of the property
* has already been changed when this callback is invoked.
*/
public fun observable<T>(initial: T, onChange: (desc: PropertyMetadata, oldValue: T, newValue: T) -> Unit): ReadWriteProperty<Any?, T> {
return ObservableProperty<T>(initial) { desc, old, new ->
onChange(desc, old, new)
true
}
public fun observable<T>(initial: T, onChange: (property: PropertyMetadata, oldValue: T, newValue: T) -> Unit): ReadWriteProperty<Any?, T> {
return ObservableProperty<T>(initial, afterChange = onChange)
}
/**
* Returns a property delegate for a read/write property that calls a specified callback function when changed,
* allowing the callback to veto the modification.
* @param initial the initial value of the property.
* @param onChange the callback which is called when a change to the property value is attempted. The new value
* is saved if the callback returns `true` and discarded if the callback returns `false`.
* @param onChange the callback which is called before a change to the property value is attempted.
* The value of the property hasn't been changed yet, when this callback is invoked.
* If the callback returns `true` the value of the property is being set to the new value,
* and if the callback returns `false` the new value is discarded and the property remains its old value.
*/
public fun vetoable<T>(initial: T, onChange: (desc: PropertyMetadata, oldValue: T, newValue: T) -> Boolean): ReadWriteProperty<Any?, T> {
return ObservableProperty<T>(initial, onChange)
public fun vetoable<T>(initial: T, onChange: (property: PropertyMetadata, oldValue: T, newValue: T) -> Boolean): ReadWriteProperty<Any?, T> {
return ObservableProperty<T>(initial, beforeChange = onChange)
}
/**
@@ -115,11 +115,17 @@ private class NotNullVar<T: Any>() : ReadWriteProperty<Any?, T> {
/**
* Implements a property delegate for a read/write property that calls a specified callback function when changed.
* @param initialValue the initial value of the property.
* @param onChange the callback which is called when a change to the property value is attempted. The new value
* is saved if the callback returns `true` and discarded if the callback returns `false`.
* @param beforeChange the callback which is called before a change to the property value is attempted.
* The value of the property hasn't been changed yet, when this callback is invoked.
* If the callback returns `true` the value of the property is being set to the new value,
* and if the callback returns `false` the new value is discarded and the property remains its old value.
* @param afterChange the callback which is called after the change of the property is made. The value of the property
* has already been changed when this callback is invoked.
*/
public class ObservableProperty<T>(
initialValue: T, private val onChange: (name: PropertyMetadata, oldValue: T, newValue: T) -> Boolean
initialValue: T,
private val beforeChange: ((property: PropertyMetadata, oldValue: T, newValue: T) -> Boolean)? = null,
private val afterChange: ((property: PropertyMetadata, oldValue: T, newValue: T) -> Unit)? = null
) : ReadWriteProperty<Any?, T> {
private var value = initialValue
@@ -128,9 +134,17 @@ public class ObservableProperty<T>(
}
public override fun set(thisRef: Any?, property: PropertyMetadata, value: T) {
if (onChange(property, this.value, value)) {
if (beforeChange == null && afterChange == null) {
this.value = value
}
else {
val oldValue = this.value
if (beforeChange != null && !(beforeChange)(property, oldValue, value)) {
return
}
this.value = value
if (afterChange != null) (afterChange)(property, oldValue, value)
}
}
}
@@ -48,7 +48,11 @@ class ObservablePropertyInChangeSupportTest: ChangeSupport() {
class ObservablePropertyTest {
var result = false
var b by Delegates.observable(1, { pd, o, n -> result = true})
var b: Int by Delegates.observable(1, { property, old, new ->
assertEquals("b", property.name)
result = true
assertEquals(new, b, "New value has already been set")
})
test fun doTest() {
b = 4
@@ -61,7 +65,12 @@ class A(val p: Boolean)
class VetoablePropertyTest {
var result = false
var b by Delegates.vetoable(A(true), { pd, o, n -> result = n.p == true; result})
var b: A by Delegates.vetoable(A(true), { property, old, new ->
assertEquals("b", property.name)
assertEquals(old, b, "New value hasn't been set yet")
result = new.p == true;
result
})
test fun doTest() {
val firstValue = A(true)