com.launchdarkly.client

Class LDUser.Builder

java.lang.Object

com.launchdarkly.client.LDUser.Builder

Enclosing class:

LDUser

public static class LDUser.Builder
extends java.lang.Object

A builder that helps construct LDUser objects. Builder calls can be chained, enabling the following pattern:

 LDUser user = new LDUser.Builder("key")
      .country("US")
      .ip("192.168.0.1")
      .build()
 

Constructor Summary

Constructors

Constructor and Description
Builder(LDUser user) Creates a builder based on an existing user.
Builder(java.lang.String key) Creates a builder with the specified key.

Method Summary

Modifier and Type	Method and Description
LDUser.Builder	anonymous(boolean anonymous) Sets whether this user is anonymous.
LDUser.Builder	avatar(java.lang.String avatar) Sets the user's avatar.
LDUser	build() Builds the configured LDUser object.
LDUser.Builder	country(LDCountryCode country) Deprecated. As of version 4.10.0. In the next major release the SDK will no longer include the LDCountryCode class. Applications should use country(String) instead.
LDUser.Builder	country(java.lang.String s) Set the country for a user.
LDUser.Builder	custom(java.lang.String k, java.lang.Boolean b) Add a Boolean-valued custom attribute.
LDUser.Builder	custom(java.lang.String k, com.google.gson.JsonElement v) Deprecated. Use custom(String, LDValue).
LDUser.Builder	custom(java.lang.String k, LDValue v) Add a custom attribute whose value can be any JSON type, using LDValue.
LDUser.Builder	custom(java.lang.String k, java.lang.Number n) Adds a Number-valued custom attribute.
LDUser.Builder	custom(java.lang.String k, java.lang.String v) Adds a String-valued custom attribute.
LDUser.Builder	customNumber(java.lang.String k, java.util.List<java.lang.Number> vs) Add a list of Number-valued custom attributes.
LDUser.Builder	customString(java.lang.String k, java.util.List<java.lang.String> vs) Add a list of String-valued custom attributes.
LDUser.Builder	customValues(java.lang.String k, java.util.List<com.google.gson.JsonElement> vs) Add a custom attribute with a list of arbitrary JSON values.
LDUser.Builder	email(java.lang.String email) Sets the user's e-mail address.
LDUser.Builder	firstName(java.lang.String firstName) Sets the user's first name
LDUser.Builder	ip(java.lang.String s) Sets the IP for a user.
LDUser.Builder	lastName(java.lang.String lastName) Sets the user's last name.
LDUser.Builder	name(java.lang.String name) Sets the user's full name.
LDUser.Builder	privateAvatar(java.lang.String avatar) Sets the user's avatar, and ensures that the avatar attribute will not be sent back to LaunchDarkly.
LDUser.Builder	privateCountry(LDCountryCode country) Deprecated. As of version 4.10.0. In the next major release the SDK will no longer include the LDCountryCode class. Applications should use privateCountry(String) instead.
LDUser.Builder	privateCountry(java.lang.String s) Set the country for a user, and ensures that the country attribute will not be sent back to LaunchDarkly.
LDUser.Builder	privateCustom(java.lang.String k, java.lang.Boolean b) Add a Boolean-valued custom attribute that will not be sent back to LaunchDarkly.
LDUser.Builder	privateCustom(java.lang.String k, com.google.gson.JsonElement v) Deprecated. Use privateCustom(String, LDValue).
LDUser.Builder	privateCustom(java.lang.String k, LDValue v) Add a custom attribute of any JSON type, that will not be sent back to LaunchDarkly.
LDUser.Builder	privateCustom(java.lang.String k, java.lang.Number n) Add a Number-valued custom attribute that will not be sent back to LaunchDarkly.
LDUser.Builder	privateCustom(java.lang.String k, java.lang.String v) Add a String-valued custom attribute that will not be sent back to LaunchDarkly.
LDUser.Builder	privateCustomNumber(java.lang.String k, java.util.List<java.lang.Number> vs) Add a list of Integer-valued custom attributes.
LDUser.Builder	privateCustomString(java.lang.String k, java.util.List<java.lang.String> vs) Add a list of String-valued custom attributes.
LDUser.Builder	privateCustomValues(java.lang.String k, java.util.List<com.google.gson.JsonElement> vs) Add a custom attribute with a list of arbitrary JSON values.
LDUser.Builder	privateEmail(java.lang.String email) Sets the user's e-mail address, and ensures that the e-mail address attribute will not be sent back to LaunchDarkly.
LDUser.Builder	privateFirstName(java.lang.String firstName) Sets the user's first name, and ensures that the first name attribute will not be sent back to LaunchDarkly.
LDUser.Builder	privateIp(java.lang.String s) Sets the IP for a user, and ensures that the IP attribute is not sent back to LaunchDarkly.
LDUser.Builder	privateLastName(java.lang.String lastName) Sets the user's last name, and ensures that the last name attribute will not be sent back to LaunchDarkly.
LDUser.Builder	privateName(java.lang.String name) Sets the user's full name, and ensures that the name attribute will not be sent back to LaunchDarkly.
LDUser.Builder	privateSecondary(java.lang.String s) Sets the secondary key for a user, and ensures that the secondary key attribute is not sent back to LaunchDarkly.
LDUser.Builder	secondary(java.lang.String s) Sets the secondary key for a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(java.lang.String key)

Creates a builder with the specified key.

Parameters:

key - the unique key for this user

Builder

public Builder(LDUser user)

Creates a builder based on an existing user.

Parameters:

user - an existing LDUser

Method Detail

ip

public LDUser.Builder ip(java.lang.String s)

Sets the IP for a user.

Parameters:

s - the IP address for the user

Returns:

the builder

privateIp

public LDUser.Builder privateIp(java.lang.String s)

Sets the IP for a user, and ensures that the IP attribute is not sent back to LaunchDarkly.

Parameters:

s - the IP address for the user

Returns:

the builder

secondary

public LDUser.Builder secondary(java.lang.String s)

Sets the secondary key for a user. This affects feature flag targeting as follows: if you have chosen to bucket users by a specific attribute, the secondary key (if set) is used to further distinguish between users who are otherwise identical according to that attribute.

Parameters:

s - the secondary key for the user

Returns:

the builder

privateSecondary

public LDUser.Builder privateSecondary(java.lang.String s)

Sets the secondary key for a user, and ensures that the secondary key attribute is not sent back to LaunchDarkly.

Parameters:

s - the secondary key for the user

Returns:

the builder

country

public LDUser.Builder country(java.lang.String s)

Set the country for a user.

In the current SDK version the country should be a valid ISO 3166-1 alpha-2 or alpha-3 code. If it is not a valid ISO-3166-1 code, an attempt will be made to look up the country by its name. If that fails, a warning will be logged, and the country will not be set. In the next major release, this validation will be removed, and the country field will be treated as a normal string.

Parameters:

s - the country for the user

Returns:

the builder

privateCountry

public LDUser.Builder privateCountry(java.lang.String s)

Set the country for a user, and ensures that the country attribute will not be sent back to LaunchDarkly.

In the current SDK version the country should be a valid ISO 3166-1 alpha-2 or alpha-3 code. If it is not a valid ISO-3166-1 code, an attempt will be made to look up the country by its name. If that fails, a warning will be logged, and the country will not be set. In the next major release, this validation will be removed, and the country field will be treated as a normal string.

Parameters:

s - the country for the user

Returns:

the builder

country

@Deprecated
public LDUser.Builder country(LDCountryCode country)

Deprecated. As of version 4.10.0. In the next major release the SDK will no longer include the LDCountryCode class. Applications should use country(String) instead.

Set the country for a user.

Parameters:

country - the country for the user

Returns:

the builder

privateCountry

@Deprecated
public LDUser.Builder privateCountry(LDCountryCode country)

Deprecated. As of version 4.10.0. In the next major release the SDK will no longer include the LDCountryCode class. Applications should use privateCountry(String) instead.

Set the country for a user, and ensures that the country attribute will not be sent back to LaunchDarkly.

Parameters:

country - the country for the user

Returns:

the builder

firstName

public LDUser.Builder firstName(java.lang.String firstName)

Sets the user's first name

Parameters:

firstName - the user's first name

Returns:

the builder

privateFirstName

public LDUser.Builder privateFirstName(java.lang.String firstName)

Sets the user's first name, and ensures that the first name attribute will not be sent back to LaunchDarkly.

Parameters:

firstName - the user's first name

Returns:

the builder

anonymous

public LDUser.Builder anonymous(boolean anonymous)

Sets whether this user is anonymous.

Parameters:

anonymous - whether the user is anonymous

Returns:

the builder

lastName

public LDUser.Builder lastName(java.lang.String lastName)

Sets the user's last name.

Parameters:

lastName - the user's last name

Returns:

the builder

privateLastName

public LDUser.Builder privateLastName(java.lang.String lastName)

Sets the user's last name, and ensures that the last name attribute will not be sent back to LaunchDarkly.

Parameters:

lastName - the user's last name

Returns:

the builder

name

public LDUser.Builder name(java.lang.String name)

Sets the user's full name.

Parameters:

name - the user's full name

Returns:

the builder

privateName

public LDUser.Builder privateName(java.lang.String name)

Sets the user's full name, and ensures that the name attribute will not be sent back to LaunchDarkly.

Parameters:

name - the user's full name

Returns:

the builder

avatar

public LDUser.Builder avatar(java.lang.String avatar)

Sets the user's avatar.

Parameters:

avatar - the user's avatar

Returns:

the builder

privateAvatar

public LDUser.Builder privateAvatar(java.lang.String avatar)

Sets the user's avatar, and ensures that the avatar attribute will not be sent back to LaunchDarkly.

Parameters:

avatar - the user's avatar

Returns:

the builder

email

public LDUser.Builder email(java.lang.String email)

Sets the user's e-mail address.

Parameters:

email - the e-mail address

Returns:

the builder

privateEmail

public LDUser.Builder privateEmail(java.lang.String email)

Sets the user's e-mail address, and ensures that the e-mail address attribute will not be sent back to LaunchDarkly.

Parameters:

email - the e-mail address

Returns:

the builder

custom

public LDUser.Builder custom(java.lang.String k,
                             java.lang.String v)

Adds a String-valued custom attribute. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the custom attribute

v - the value for the custom attribute

Returns:

the builder

custom

public LDUser.Builder custom(java.lang.String k,
                             java.lang.Number n)

Adds a Number-valued custom attribute. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the custom attribute

n - the value for the custom attribute

Returns:

the builder

custom

public LDUser.Builder custom(java.lang.String k,
                             java.lang.Boolean b)

Add a Boolean-valued custom attribute. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the custom attribute

b - the value for the custom attribute

Returns:

the builder

custom

public LDUser.Builder custom(java.lang.String k,
                             LDValue v)

Add a custom attribute whose value can be any JSON type, using LDValue. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the custom attribute

v - the value for the custom attribute

Returns:

the builder

Since:

4.8.0

custom

@Deprecated
public LDUser.Builder custom(java.lang.String k,
                                         com.google.gson.JsonElement v)

Deprecated. Use custom(String, LDValue).

Add a custom attribute whose value can be any JSON type. This is equivalent to custom(String, LDValue) but uses the Gson type JsonElement. Using LDValue is preferred; the Gson types may be removed from the public API in the future.

Parameters:

k - the key for the custom attribute

v - the value for the custom attribute

Returns:

the builder

customString

public LDUser.Builder customString(java.lang.String k,
                                   java.util.List<java.lang.String> vs)

Add a list of String-valued custom attributes. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the list

vs - the values for the attribute

Returns:

the builder

customNumber

public LDUser.Builder customNumber(java.lang.String k,
                                   java.util.List<java.lang.Number> vs)

Add a list of Number-valued custom attributes. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the list

vs - the values for the attribute

Returns:

the builder

customValues

public LDUser.Builder customValues(java.lang.String k,
                                   java.util.List<com.google.gson.JsonElement> vs)

Add a custom attribute with a list of arbitrary JSON values. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the list

vs - the values for the attribute

Returns:

the builder

privateCustom

public LDUser.Builder privateCustom(java.lang.String k,
                                    java.lang.String v)

Add a String-valued custom attribute that will not be sent back to LaunchDarkly. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the custom attribute

v - the value for the custom attribute

Returns:

the builder

privateCustom

public LDUser.Builder privateCustom(java.lang.String k,
                                    java.lang.Number n)

Add a Number-valued custom attribute that will not be sent back to LaunchDarkly. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the custom attribute

n - the value for the custom attribute

Returns:

the builder

privateCustom

public LDUser.Builder privateCustom(java.lang.String k,
                                    java.lang.Boolean b)

Add a Boolean-valued custom attribute that will not be sent back to LaunchDarkly. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the custom attribute

b - the value for the custom attribute

Returns:

the builder

privateCustom

public LDUser.Builder privateCustom(java.lang.String k,
                                    LDValue v)

Add a custom attribute of any JSON type, that will not be sent back to LaunchDarkly. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the custom attribute

v - the value for the custom attribute

Returns:

the builder

Since:

4.8.0

privateCustom

@Deprecated
public LDUser.Builder privateCustom(java.lang.String k,
                                                com.google.gson.JsonElement v)

Deprecated. Use privateCustom(String, LDValue).

Add a custom attribute of any JSON type, that will not be sent back to LaunchDarkly. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

Parameters:

k - the key for the custom attribute

v - the value for the custom attribute

Returns:

the builder

privateCustomString

public LDUser.Builder privateCustomString(java.lang.String k,
                                          java.util.List<java.lang.String> vs)

Add a list of String-valued custom attributes. When set to one of the built-in user attribute keys, this custom attribute will be ignored. The custom attribute value will not be sent back to LaunchDarkly in analytics events.

Parameters:

k - the key for the list. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

vs - the values for the attribute

Returns:

the builder

privateCustomNumber

public LDUser.Builder privateCustomNumber(java.lang.String k,
                                          java.util.List<java.lang.Number> vs)

Add a list of Integer-valued custom attributes. When set to one of the built-in user attribute keys, this custom attribute will be ignored. The custom attribute value will not be sent back to LaunchDarkly in analytics events.

Parameters:

k - the key for the list. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

vs - the values for the attribute

Returns:

the builder

privateCustomValues

public LDUser.Builder privateCustomValues(java.lang.String k,
                                          java.util.List<com.google.gson.JsonElement> vs)

Add a custom attribute with a list of arbitrary JSON values. When set to one of the built-in user attribute keys, this custom attribute will be ignored. The custom attribute value will not be sent back to LaunchDarkly in analytics events.

Parameters:

k - the key for the list

vs - the values for the attribute

Returns:

the builder

build

public LDUser build()

Builds the configured LDUser object.

Returns:

the LDUser configured by this builder