Object/Class

com.twitter.finagle.toggle

Toggle

Related Docs: class Toggle | package toggle

Permalink

object Toggle

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Toggle
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Captured extends AnyRef

    Permalink

    A mixin to get access to the last result of Toggle.apply.

    A mixin to get access to the last result of Toggle.apply.

    Useful for providing visibility to how a toggle is being used at runtime.

    See also

    ToggleMap.observed

  2. case class Metadata(id: String, fraction: Double, description: Option[String], source: String) extends Product with Serializable

    Permalink

    The metadata about a Toggle.

    The metadata about a Toggle.

    id

    the identifying name of the Toggle. These should generally be fully qualified names to avoid conflicts between libraries. For example, "com.twitter.finagle.CoolThing". Valid characters are A-Z, a-z, 0-9, _, -, .. See Toggle$.isValidId.

    fraction

    must be between 0.0 and 1.0, inclusive. This represents the fraction of inputs that will return true. See Toggle$.isValidFraction.

    description

    human-readable description of the Toggle's purpose.

    source

    the origin of this Toggle which is often given by toString of the ToggleMap that created it.

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. object Fractional

    Permalink

    Namespace for methods that operate on Toggle.Fractional

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  13. def isValidFraction(fraction: Double): Boolean

    Permalink

    Whether or not the given fraction is valid.

    Whether or not the given fraction is valid.

    fraction

    must be between 0.0 and 1.0, inclusive. This represents the fraction of inputs that will return true.

  14. def isValidId(id: String): Boolean

    Permalink

    Whether or not the given id is valid.

    Whether or not the given id is valid.

    id

    the identifying name of the Toggle. These should generally be fully qualified names to avoid conflicts between libraries. For example, "com.twitter.finagle.CoolThing". Valid characters are A-Z, a-z, 0-9, _, -, ..

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. def off[T](id: String): Fractional[T]

    Permalink

    A Toggle which is defined for all inputs and always returns false.

  19. def on[T](id: String): Fractional[T]

    Permalink

    A Toggle which is defined for all inputs and always returns true.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped