Class/Object

com.twitter.util.tunable

Tunable

Related Docs: object Tunable | package tunable

Permalink

sealed abstract class Tunable[T] extends AnyRef

A Tunable is an abstraction for an object that produces a Some(value) or None when applied. Implementations may enable mutation, such that successive applications of the Tunable produce different values.

For more information about Tunables, see https://twitter.github.io/finagle/guide/Configuration.html#tunables

T

type of value this Tunable holds

Self Type
Tunable[T]
Linear Supertypes
AnyRef, Any
Known Subclasses
Const, Mutable
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tunable
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply(): Option[T]

    Permalink

    Returns the current value of this Tunable as an Option.

    Returns the current value of this Tunable as an Option. If the Tunable has a value, returns Some(value). Otherwise, returns None.

  2. abstract def asVar: Var[Option[T]]

    Permalink

    Returns a Var that observes this Tunable.

    Returns a Var that observes this Tunable. Observers of the Var will be notified whenever the value of this Tunable is updated.

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. val id: String

    Permalink

    id of this Tunable, used in toString.

    id of this Tunable, used in toString. Must not be empty and should be unique.

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. def map[A](f: (T) ⇒ A): Tunable[A]

    Permalink

    Returns a Tunable containing the result of applying f to this Tunable value.

    Returns a Tunable containing the result of applying f to this Tunable value.

    Note

    the returned Tunable will have the id of this Tunable

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. def orElse(that: Tunable[T]): Tunable[T]

    Permalink

    Compose this Tunable with another Tunable.

    Compose this Tunable with another Tunable. Application of the returned Tunable will return the result of applying this Tunable, if it is defined and the result of applying the other Tunable if not.

    Note

    the returned Tunable will have the id of this Tunable

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  19. def toString(): String

    Permalink
    Definition Classes
    Tunable → AnyRef → Any

  20. final def wait(): Unit

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

  21. final def wait(arg0: Long, arg1: Int): Unit

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

  22. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped