Package com.variant.share.schema

Interface State

public interface State
Representation of a state. Specified in an element of the required /states list key.
Since:
0.5

  • Method Details

    • getSchema

      Schema getSchema()
      The containing experiment schema.
      Since:
      0.6

    • getName

      String getName()
      This state's name. Specified in the required /states[]/name key.
      Since:
      0.5

    • getParameters

      Map<String,String> getParameters()
      This state's parameters. Specified in the optional /states[]/parameters list key.
      Returns:
      An immutable map of state parameters.
      Since:
      0.6

    • getHooks

      List<StateHook> getHooks()
      This list's state-scoped lifecycle hooks. Specified the optional /states[]/hooks list key.
      Returns:
      An immutable list of StateHook objects in ordinal order.
      Since:
      0.8

    • getInstrumentedExperiments

      List<Experiment> getInstrumentedExperiments()
      A list of experiments instrumented on this state.
      Returns:
      An immutable list of Experiment objects.
      Since:
      0.5

    • isInstrumentedBy

      boolean isInstrumentedBy(Experiment experiment)
      Is this state instrumented by a given experiment. In other words, is a given experiment contained in the list, returned by getInstrumentedExperiments()?
      Since:
      0.5