Package com.variant.share.schema
Interface StateVariant
public interface StateVariant
Representation of an instrumentation of a given state by a given variant.
Specified by an element of the required
/variations[]/onState[]/variants
list key.- Since:
- 0.5
-
Method Summary
Modifier and TypeMethodDescriptionThe list of this variant's concurrent experiences.This variant's proper experience.The containingVariation.OnState
object.This variant's state parameters.getState()
The state associated with this state variant.The variation associated with this state variant.boolean
isProper()
Is this a proper variant? Equivalent to
.getConcurrentExperiences()
.isEmpty()
-
Method Details
-
getOnState
Variation.OnState getOnState()The containingVariation.OnState
object.- Since:
- 0.5
-
getState
State getState()The state associated with this state variant. Equivalent togetOnState()
.getState().- Since:
- 0.6
-
getVariation
Variation getVariation()The variation associated with this state variant. Equivalent togetOnState()
.getVariation().- Since:
- 0.5
-
getExperience
Variation.Experience getExperience()This variant's proper experience. Specified in the required/variations[]/onState[]/variants[]/experience
key.- Since:
- 0.5
-
getConcurrentExperiences
List<Variation.Experience> getConcurrentExperiences()The list of this variant's concurrent experiences. Specified in the optional/variations[]/onState[]/variants[]/concurrentExperiences
list key.- Since:
- 0.5
-
isProper
boolean isProper()Is this a proper variant? Equivalent to
.getConcurrentExperiences()
.isEmpty()- Since:
- 0.6
-
getParameters
This variant's state parameters.- Returns:
- Immutable map containing all parameters defined by this state variant, subject to parameter cascading.
- Since:
- 0.5
-