Package com.launchdarkly.sdk.server.integrations

Class TestData.FlagBuilder

    • Method Detail

      • booleanFlag

        public TestData.FlagBuilder booleanFlag()
        A shortcut for setting the flag to use the standard boolean configuration.

        This is the default for all new flags created with TestData.flag(String). The flag will have two variations, true and false (in that order); it will return false whenever targeting is off, and true when targeting is on if no other settings specify otherwise.

        Returns:
        the builder

      • on

        public TestData.FlagBuilder on​(boolean on)
        Sets targeting to be on or off for this flag.

        The effect of this depends on the rest of the flag configuration, just as it does on the real LaunchDarkly dashboard. In the default configuration that you get from calling TestData.flag(String) with a new flag key, the flag will return false whenever targeting is off, and true when targeting is on.

        Parameters:
        on - true if targeting should be on
        Returns:
        the builder

      • fallthroughVariation

        public TestData.FlagBuilder fallthroughVariation​(boolean value)
        Specifies the fallthrough variation for a boolean flag. The fallthrough is the value that is returned if targeting is on and the context was not matched by a more specific target or rule.

        If the flag was previously configured with other variations, this also changes it to a boolean flag.

        Parameters:
        value - true if the flag should return true by default when targeting is on
        Returns:
        the builder

      • fallthroughVariation

        public TestData.FlagBuilder fallthroughVariation​(int variationIndex)
        Specifies the index of the fallthrough variation. The fallthrough is the variation that is returned if targeting is on and the context was not matched by a more specific target or rule.
        Parameters:
        variationIndex - the desired fallthrough variation: 0 for the first, 1 for the second, etc.
        Returns:
        the builder

      • offVariation

        public TestData.FlagBuilder offVariation​(boolean value)
        Specifies the off variation for a boolean flag. This is the variation that is returned whenever targeting is off.
        Parameters:
        value - true if the flag should return true when targeting is off
        Returns:
        the builder

      • offVariation

        public TestData.FlagBuilder offVariation​(int variationIndex)
        Specifies the index of the off variation. This is the variation that is returned whenever targeting is off.
        Parameters:
        variationIndex - the desired off variation: 0 for the first, 1 for the second, etc.
        Returns:
        the builder

      • variationForAll

        public TestData.FlagBuilder variationForAll​(boolean variation)
        Sets the flag to always return the specified boolean variation for all contexts.

        Targeting is switched on, any existing targets or rules are removed, and the flag's variations are set to true and false. The fallthrough variation is set to the specified value. The off variation is left unchanged.

        Parameters:
        variation - the desired true/false variation to be returned for all contexts
        Returns:
        the builder
        Since:
        5.10.0
        See Also:
        variationForAll(int), valueForAll(LDValue)

      • variationForAll

        public TestData.FlagBuilder variationForAll​(int variationIndex)
        Sets the flag to always return the specified variation for all contexts.

        The variation is specified by number, out of whatever variation values have already been defined. Targeting is switched on, and any existing targets or rules are removed. The fallthrough variation is set to the specified value. The off variation is left unchanged.

        Parameters:
        variationIndex - the desired variation: 0 for the first, 1 for the second, etc.
        Returns:
        the builder
        See Also:
        variationForAll(boolean), valueForAll(LDValue)

      • valueForAll

        public TestData.FlagBuilder valueForAll​(LDValue value)
        Sets the flag to always return the specified variation value for all users.

        The value may be of any JSON type, as defined by LDValue. This method changes the flag to have only a single variation, which is this value, and to return the same variation regardless of whether targeting is on or off. Any existing targets or rules are removed.

        Parameters:
        value - the desired value to be returned for all users
        Returns:
        the builder
        See Also:
        variationForAll(boolean), variationForAll(int)

      • variationForUser

        public TestData.FlagBuilder variationForUser​(java.lang.String userKey,
                                             boolean variation)
        Sets the flag to return the specified boolean variation for a specific user key (that is, for a context with that key whose context kind is "user") when targeting is on.

        This has no effect when targeting is turned off for the flag.

        If the flag was not already a boolean flag, this also changes it to a boolean flag.

        Parameters:
        userKey - a user key
        variation - the desired true/false variation to be returned for this user when targeting is on
        Returns:
        the builder
        See Also:
        variationForUser(String, int), variationForKey(ContextKind, String, boolean)

      • variationForKey

        public TestData.FlagBuilder variationForKey​(ContextKind contextKind,
                                            java.lang.String key,
                                            boolean variation)
        Sets the flag to return the specified boolean variation for a specific context, identified by context kind and key, when targeting is on.

        This has no effect when targeting is turned off for the flag.

        If the flag was not already a boolean flag, this also changes it to a boolean flag.

        Parameters:
        contextKind - the context kind
        key - the context key
        variation - the desired true/false variation to be returned for this context when targeting is on
        Returns:
        the builder
        Since:
        6.0.0
        See Also:
        variationForKey(ContextKind, String, int), variationForUser(String, boolean)

      • variationForUser

        public TestData.FlagBuilder variationForUser​(java.lang.String userKey,
                                             int variationIndex)
        Sets the flag to return the specified variation for a specific user key (that is, for a context with that key whose context kind is "user") when targeting is on.

        This has no effect when targeting is turned off for the flag.

        The variation is specified by number, out of whatever variation values have already been defined.

        Parameters:
        userKey - a user key
        variationIndex - the desired variation to be returned for this user when targeting is on: 0 for the first, 1 for the second, etc.
        Returns:
        the builder
        See Also:
        variationForKey(ContextKind, String, int), variationForUser(String, boolean)

      • variationForKey

        public TestData.FlagBuilder variationForKey​(ContextKind contextKind,
                                            java.lang.String key,
                                            int variationIndex)
        Sets the flag to return the specified boolean variation for a specific context, identified by context kind and key, when targeting is on.

        This has no effect when targeting is turned off for the flag.

        If the flag was not already a boolean flag, this also changes it to a boolean flag.

        Parameters:
        contextKind - the context kind
        key - the context key
        variationIndex - the desired variation to be returned for this context when targeting is on: 0 for the first, 1 for the second, etc.
        Returns:
        the builder
        Since:
        6.0.0
        See Also:
        variationForKey(ContextKind, String, boolean), variationForUser(String, int)

      • variations

        public TestData.FlagBuilder variations​(LDValue... values)
        Changes the allowable variation values for the flag.

        The value may be of any JSON type, as defined by LDValue. For instance, a boolean flag normally has LDValue.of(true), LDValue.of(false); a string-valued flag might have LDValue.of("red"), LDValue.of("green"); etc.

        Parameters:
        values - the desired variations
        Returns:
        the builder

      • samplingRatio

        public TestData.FlagBuilder samplingRatio​(long samplingRatio)
        Set the samplingRatio, used for event generation, for this flag.
        Parameters:
        samplingRatio - the event sampling ratio
        Returns:
        a reference to this builder

      • migrationCheckRatio

        public TestData.FlagBuilder migrationCheckRatio​(long checkRatio)
        Turn this flag into a migration flag and set the check ratio.
        Parameters:
        checkRatio - the check ratio
        Returns:
        a reference to this builder