JsonToggleMap

Type Members

sealed abstract class DescriptionMode extends AnyRef

How to treat the "description" field on a toggle.
How to treat the "description" field on a toggle.

See also
DescriptionIgnored and DescriptionRequired.

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
object DescriptionIgnored extends DescriptionMode

Transforms the Toggle's "description" field into being empty.
Transforms the Toggle's "description" field into being empty.
This is useful for service owner overrides of a toggle where the developer making modifications is not the one who has defined the toggle itself.
object DescriptionRequired extends DescriptionMode

Requires toggles to have a "description" field.
Requires toggles to have a "description" field.
This is useful for the library owner's base definitions of Toggle.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def mutableToJson(registry: Map[String, Mutable]): String

Serialize a ToggleMap to JSON format
Serialize a ToggleMap to JSON format

Note
this is a helper for Java friendliness. Scala users should continue to use toJson.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef

def parse(url: URL, descriptionMode: DescriptionMode): Try[ToggleMap]

Attempts to parse the given JSON URL into a ToggleMap.

Useful for loading resource files via StandardToggleMap.

The JSON Schema used is:

{
  "$schema": "https://json-schema.org/draft-04/schema#",
  "type": "object",
  "required": [
    "toggles"
  ],
  "properties": {
    "toggles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "description": { "type": "string" },
          "fraction": {
            "type": "number",
            "minimum": 0.0,
            "maximum": 1.0,
            "exclusiveMinimum": false,
            "exclusiveMaxmimum": false
          },
          "comment": { "type": "string" }
        },
        "required": [
          "id",
          "fraction"
        ]
      }
    }
  }
}

Here is an example of a JSON ToggleMap input:

{
  "toggles": [
    {
      "id": "com.game.of.thrones.WargingEnabled",
      "description": "Use warging for computing the response.",
      "fraction": 0.1
    },
    {
      "id": "com.game.of.thrones.IsWinterComing",
      "description": "Controls whether or not winter is coming.",
      "fraction": 1.0,
      "comment": "We've seen the white walkers, we know that winter is coming."
    }
  ]
}

With the exception of "comment", the properties correspond to the various fields on Toggle.Metadata.

name: Corresponds to Toggle.Metadata.id.
fraction: Corresponds to Toggle.Metadata.fraction and values must be between 0.0 and 1.0, inclusive.
description: Corresponds to Toggle.Metadata.description.
comment: For documentation purposes only and is not used in the creation of the ToggleMap.

descriptionMode: how to treat the "description" field for a toggle.

def parse(json: String, descriptionMode: DescriptionMode): Try[ToggleMap]

Attempts to parse the given JSON String into a ToggleMap.

The JSON Schema used is:

{
  "$schema": "https://json-schema.org/draft-04/schema#",
  "type": "object",
  "required": [
    "toggles"
  ],
  "properties": {
    "toggles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "description": { "type": "string" },
          "fraction": {
            "type": "number",
            "minimum": 0.0,
            "maximum": 1.0,
            "exclusiveMinimum": false,
            "exclusiveMaxmimum": false
          },
          "comment": { "type": "string" }
        },
        "required": [
          "id",
          "fraction"
        ]
      }
    }
  }
}

Here is an example of a JSON ToggleMap input:

{
  "toggles": [
    {
      "id": "com.game.of.thrones.WargingEnabled",
      "description": "Use warging for computing the response.",
      "fraction": 0.1
    },
    {
      "id": "com.game.of.thrones.IsWinterComing",
      "description": "Controls whether or not winter is coming.",
      "fraction": 1.0,
      "comment": "We've seen the white walkers, we know that winter is coming."
    }
  ]
}

With the exception of "comment", the properties correspond to the various fields on Toggle.Metadata.

name: Corresponds to Toggle.Metadata.id.
fraction: Corresponds to Toggle.Metadata.fraction and values must be between 0.0 and 1.0, inclusive.
description: Corresponds to Toggle.Metadata.description.
comment: For documentation purposes only and is not used in the creation of the ToggleMap.

descriptionMode: how to treat the "description" field for a toggle.

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

Definition Classes
AnyRef
def toJson(registry: Map[String, ToggleMap]): String

Serialize a ToggleMap to JSON format
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package toggle

object JsonToggleMap

Type Members

sealed abstract class DescriptionMode extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object DescriptionIgnored extends DescriptionMode

object DescriptionRequired extends DescriptionMode

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def mutableToJson(registry: Map[String, Mutable]): String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parse(url: URL, descriptionMode: DescriptionMode): Try[ToggleMap]

def parse(json: String, descriptionMode: DescriptionMode): Try[ToggleMap]

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

def toJson(registry: Map[String, ToggleMap]): String

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped