Trait

net.liftweb.util

AnyVarTrait

Related Doc: package util

Permalink

trait AnyVarTrait[T, MyType <: AnyVarTrait[T, MyType]] extends PSettableValueHolder[T] with HasCalcDefaultValue[T]

Abstract a request or a session scoped variable.

Self Type
MyType
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AnyVarTrait
  2. HasCalcDefaultValue
  3. PSettableValueHolder
  4. SettableValueHolder
  5. Settable
  6. PValueHolder
  7. ValueHolder
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. abstract type CleanUpParam

    Permalink
  2. type FuncType = (Box[T], Boolean) ⇒ Unit

    Permalink

    The function takes a Box[T] (Full if the Var is being set, Empty if it's being cleared) and a Boolean indicating that the set function is setting to the default value.

  3. type ValueType = T

    Permalink
    Definition Classes
    PValueHolderValueHolder

Abstract Value Members

  1. abstract def calcDefaultValue: T

    Permalink
    Attributes
    protected
    Definition Classes
    AnyVarTraitHasCalcDefaultValue
  2. abstract def clearFunc(name: String): Unit

    Permalink
    Attributes
    protected
  3. abstract def doSync[F](f: ⇒ F): F

    Permalink

    Different Vars require different mechanisms for synchronization.

    Different Vars require different mechanisms for synchronization. This method implements the Var specific synchronization mechanism

  4. abstract def findFunc(name: String): Box[T]

    Permalink
    Attributes
    protected
  5. abstract def registerCleanupFunc(in: (MyType.CleanUpParam) ⇒ Unit): Unit

    Permalink
    Attributes
    protected
  6. abstract def setFunc(name: String, value: T): Unit

    Permalink
    Attributes
    protected
  7. abstract def testWasSet(name: String, initedKey: String): Boolean

    Permalink

    A non-side-effecting test if the value was initialized

    A non-side-effecting test if the value was initialized

    Attributes
    protected
  8. abstract def wasInitialized(name: String, initedKey: String): Boolean

    Permalink
    Attributes
    protected

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def __nameSalt: String

    Permalink
    Attributes
    protected
  5. def apply(what: T): T

    Permalink

    Set the session variable

    Set the session variable

    what

    -- the value to set the session variable to

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def atomicUpdate(f: (MyType.ValueType) ⇒ MyType.ValueType): MyType.ValueType

    Permalink

    Perform an atomic update of this Settable.

    Perform an atomic update of this Settable. The current value is passed to the function and the ValueHolder is set to the result of the function. This is enclosed in the performAtomicOperation method which will, by default, synchronize this instance

    Definition Classes
    Settable
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def doWith[F](newVal: T)(f: ⇒ F): F

    Permalink

    Change the value of the Var for the lifespan of the function

  10. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def get: T

    Permalink

    Shadow of the 'is' method

    Shadow of the 'is' method

    Definition Classes
    AnyVarTraitValueHolder
  14. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def is: T

    Permalink

    The current value of the variable

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. lazy val name: String

    Permalink
    Attributes
    protected
  19. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  22. def onChange(f: MyType.FuncType): Unit

    Permalink

    On any change to this Var, invoke the function.

    On any change to this Var, invoke the function. Changes are setting the value, clearing the value. There may not be a call if the Var goes out of scope (e.g., a RequestVar at the end of the Request).

    The function takes a Box[T] (Full if the Var is being set, Empty if it's being cleared) and a Boolean indicating that the set function is setting to the default value.

    The function should execute *very* quickly (e.g., Schedule a function to be executed on a different thread).

    The function should generally be set in Boot or when a singleton is created.

    f

    the function to execute on change

  23. def onShutdown(session: MyType.CleanUpParam): Unit

    Permalink
    Attributes
    protected
  24. def performAtomicOperation[T](f: ⇒ T): T

    Permalink

    Perform an atomic operation on the Settable.

    Perform an atomic operation on the Settable. By default synchronizes the instance, but it could use other mechanisms

    Definition Classes
    Settable
  25. final def registerGlobalCleanupFunc(in: (MyType.CleanUpParam) ⇒ Unit): Unit

    Permalink
    Attributes
    protected
  26. def remove(): Unit

    Permalink
  27. def set(what: T): T

    Permalink

    Shadow of the apply method

    Shadow of the apply method

    Definition Classes
    AnyVarTraitSettable
  28. def setIfUnset(value: ⇒ T): T

    Permalink

    Set the Var if it has not been calculated

  29. def set_?: Boolean

    Permalink

    Has this Var been set or accessed and had its default value calculated

  30. def settingDefault_?: Boolean

    Permalink
    Attributes
    protected
  31. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyVarTrait → AnyRef → Any
  33. def update(f: (T) ⇒ T): T

    Permalink

    Applies the given function to the contents of this variable and sets the variable to the resulting value.

    Applies the given function to the contents of this variable and sets the variable to the resulting value.

    f

    -- the function to apply and set the result from.

  34. final def wait(): Unit

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

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

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

Inherited from HasCalcDefaultValue[T]

Inherited from PSettableValueHolder[T]

Inherited from SettableValueHolder

Inherited from Settable

Inherited from PValueHolder[T]

Inherited from ValueHolder

Inherited from AnyRef

Inherited from Any

Ungrouped