Class/Object

reactify

Var

Related Docs: object Var | package reactify

Permalink

class Var[T] extends Val[T] with StateChannel[T]

Var, as the name suggests, is very similar to a Scala var. The value is defined during instantiation, but may be modified later. The value may be a static value, or may be a derived value depending on multiple Observables. If Observables make up the value they will be monitored and events fired on this Observable as the value changes.

T

the type of value this channel receives

Linear Supertypes
StateChannel[T], Channel[T], Val[T], AbstractState[T], State[T], Observable[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Var
  2. StateChannel
  3. Channel
  4. Val
  5. AbstractState
  6. State
  7. Observable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Var(function: () ⇒ T, distinct: Boolean = true, cache: Boolean = true)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def :=(value: ⇒ T): Unit

    Permalink

    Convenience method to send a value to set similarly to an assignment operator.

    Convenience method to send a value to set similarly to an assignment operator.

    value

    the value to apply

    Definition Classes
    Channel
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def and(that: Observable[T]): Observable[T]

    Permalink
    Definition Classes
    Observable
  6. def apply(): T

    Permalink
    Definition Classes
    State
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def asVal: Val[T]

    Permalink
  9. def attach(f: (T) ⇒ Unit, priority: Double = Listener.Priority.Normal): Listener[T]

    Permalink

    Attaches a function to listen to values fired against this Observable.

    Attaches a function to listen to values fired against this Observable.

    f

    function listener

    returns

    the supplied function. This reference is useful for detaching the function later

    Definition Classes
    Observable
  10. def attachAndFire(f: (T) ⇒ Unit): Listener[T]

    Permalink
    Definition Classes
    State
  11. def changes(listener: ChangeListener[T]): Listener[T]

    Permalink

    Works similarly to attach, but also references the previous value that was fired.

    Works similarly to attach, but also references the previous value that was fired. This is useful when you need to handle changes, not just new values.

    listener

    the ChangeListener

    returns

    the listener attached. This can be passed to detach to remove this listener

    Definition Classes
    StateObservable
  12. def clear(): Unit

    Permalink

    Clears all attached observers from this Observable.

    Clears all attached observers from this Observable.

    Definition Classes
    Observable
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def detach(listener: Listener[T]): Unit

    Permalink

    Detaches a function from listening to this Observable.

    Detaches a function from listening to this Observable.

    listener

    function listener that was previously attached

    Definition Classes
    Observable
  15. def dispose(): Unit

    Permalink

    Cleans up all cross references in preparation for releasing for GC.

    Cleans up all cross references in preparation for releasing for GC.

    Definition Classes
    AbstractStateObservable
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def fire(value: T): Unit

    Permalink
    Attributes
    protected[reactify]
    Definition Classes
    Observable
  20. final def fireRecursive(value: T, invocation: Invocation, observers: List[Listener[T]]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Observable
  21. def future(condition: (T) ⇒ Boolean = (t: T) => true): Future[T]

    Permalink

    Returns a Future[T] that represents the value of the next firing of this Observable.

    Returns a Future[T] that represents the value of the next firing of this Observable.

    condition

    the condition under which the listener will be invoked. Defaults to always return true.

    Definition Classes
    Observable
  22. def get(cache: Boolean): T

    Permalink
    Definition Classes
    AbstractState
  23. def get: T

    Permalink
    Definition Classes
    AbstractStateState
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. def observe(listener: Listener[T]): Listener[T]

    Permalink

    Direct attachment of a listener.

    Direct attachment of a listener.

    listener

    the listener to attach

    returns

    the same listener supplied

    Definition Classes
    Observable
  31. def observing: Set[Observable[_]]

    Permalink
    Definition Classes
    AbstractStateState
  32. def on(f: ⇒ Unit, priority: Double = Listener.Priority.Normal): Listener[T]

    Permalink

    Works like attach, but doesn't receive the fired value.

    Works like attach, but doesn't receive the fired value.

    f

    function to invoke on fire

    returns

    listener

    Definition Classes
    Observable
  33. def once(f: (T) ⇒ Unit, condition: (T) ⇒ Boolean = (_: T) => true, priority: Double = Listener.Priority.Normal): Listener[T]

    Permalink

    Invokes the listener only one time and then detaches itself.

    Invokes the listener only one time and then detaches itself. If supplied, the condition filters the scenarios in which the listener will be invoked.

    f

    the function listener

    condition

    the condition under which the listener will be invoked. Defaults to always return true.

    Definition Classes
    Observable
  34. def replace(function: () ⇒ T, newFunction: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    AbstractState
  35. def set(value: ⇒ T): Unit

    Permalink

    Fires the value to all attached listeners.

    Fires the value to all attached listeners.

    value

    the value to apply

    Definition Classes
    VarChannelAbstractState
  36. def setStatic(value: T): Unit

    Permalink

    Convenience method to pre-evaluate the value instead of as an anonymous function.

    Convenience method to pre-evaluate the value instead of as an anonymous function.

    value

    the value to be set

    Definition Classes
    VarAbstractState
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  38. def toString(): String

    Permalink
    Definition Classes
    VarVal → AnyRef → Any
  39. def value: T

    Permalink
    Definition Classes
    State
  40. def value_=(value: ⇒ T): Unit

    Permalink

    Convenience method to set the current value like a variable.

  41. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from StateChannel[T]

Inherited from Channel[T]

Inherited from Val[T]

Inherited from AbstractState[T]

Inherited from State[T]

Inherited from Observable[T]

Inherited from AnyRef

Inherited from Any

Ungrouped