Packages

abstract class ToggleMap extends AnyRef

A collection of Int-typed toggles which can be used to build a form of feature toggles which allow for modifying behavior without changing code.

Expected usage is for code to have toggles passed into their constructors instead of dynamically creating new toggles on every call.

Self Type
ToggleMap
See also

Toggle

ServiceLoadedToggleMap and StandardToggleMap for typical usage entry points.

Feature Toggles for detailed discussion on the topic.

Linear Supertypes
AnyRef, Any
Known Subclasses
NullToggleMap, ServiceLoadedToggleMap, Immutable, Mutable
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ToggleMap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ToggleMap()

Abstract Value Members

  1. abstract def apply(id: String): Toggle

    Get a Toggle for this id.

    Get a Toggle for this id.

    The Toggle.isDefined method should return false if the ToggleMap does not know about that Toggle or it is currently not "operating" on that id.

    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".

    See also

    get for a Java friendly version

  2. abstract def iterator: Iterator[Metadata]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def get(id: String): Toggle

    Get a Toggle for this id.

    Get a Toggle for this id. Java-friendly synonym for apply.

    The Toggle.isDefined method should return false if the ToggleMap does not know about that Toggle or it is currently not "operating" on that id.

    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".

    Note

    this returns a java.lang.Integer for Java compatibility.

  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def orElse(that: ToggleMap): ToggleMap

    Creates a ToggleMap which uses this before that.

    Creates a ToggleMap which uses this before that.

    apply returns a Toggle that uses the Toggle from this if it isDefined for the input, before trying that.

    iterator includes metadata from both self and that, with self's metadata taking precedence on conflicting ids. Note however that if a ToggleMetadata.description is not defined on self, the description from that will be preferred. This is done because many sources of ToggleMaps do not have a description defined and we want to surface that information.

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped