com.launchdarkly.android

Class LDUser.Builder

java.lang.Object

com.launchdarkly.android.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)
Builder(java.lang.String key) Create 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() Build the configured LDUser object
LDUser.Builder	country(LDCountryCode country) Set the country for a user.
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, java.util.List<java.lang.String> vs) Deprecated. As of version 0.16.0, renamed to customString
LDUser.Builder	custom(java.lang.String k, java.lang.Number n) Add a Number-valued custom attribute.
LDUser.Builder	custom(java.lang.String k, java.lang.String v) Add a String-valued custom attribute.
LDUser.Builder	customNumber(java.lang.String k, java.util.List<java.lang.Number> vs) Add a list of Integer-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	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) Set 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.
LDUser.Builder	privateCountry(LDCountryCode country) Set the country for a user.
LDUser.Builder	privateCountry(java.lang.String s) Set the country for a user.
LDUser.Builder	privateCustom(java.lang.String k, java.lang.Boolean b) Add a Boolean-valued custom attribute.
LDUser.Builder	privateCustom(java.lang.String k, java.lang.Number n) Add a Number-valued custom attribute.
LDUser.Builder	privateCustom(java.lang.String k, java.lang.String v) Add a String-valued custom attribute.
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	privateEmail(java.lang.String email) Sets the user's e-mail address.
LDUser.Builder	privateFirstName(java.lang.String firstName) Sets the user's first name.
LDUser.Builder	privateIp(java.lang.String s) Set the IP for a user.
LDUser.Builder	privateLastName(java.lang.String lastName) Sets the user's last name.
LDUser.Builder	privateName(java.lang.String name) Sets the user's full name.
LDUser.Builder	privateSecondary(java.lang.String s)
LDUser.Builder	secondary(java.lang.String s)

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)

Create a builder with the specified key

Parameters:

key - the unique key for this user

Builder

public Builder(LDUser user)

Method Detail

ip

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

Set 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)

Set the IP for a user. Private attributes are not recorded in events.

Parameters:

s - the IP address for the user

Returns:

the builder

secondary

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

privateSecondary

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

country

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

Set the country for a user. 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.

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. 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. Private attributes are not recorded in events.

Parameters:

s - the country for the user

Returns:

the builder

country

public LDUser.Builder country(LDCountryCode country)

Set the country for a user.

Parameters:

country - the country for the user

Returns:

the builder

privateCountry

public LDUser.Builder privateCountry(LDCountryCode country)

Set the country for a user. Private attributes are not recorded in events.

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. Private attributes are not recorded in events.

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. Private attributes are not recorded in events.

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. Private attributes are not recorded in events.

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. Private attributes are not recorded in events.

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. Private attributes are not recorded in events.

Parameters:

email - the e-mail address

Returns:

the builder

custom

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

Add 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

privateCustom

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

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

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)

Add 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. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

n - 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. When set to one of the built-in user attribute keys, this custom attribute will be ignored. Private attributes are not recorded in events.

Parameters:

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

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. When set to one of the built-in user attribute keys, this custom attribute will be ignored.

b - 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. When set to one of the built-in user attribute keys, this custom attribute will be ignored. Private attributes are not recorded in events.

Parameters:

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

b - the value for the custom attribute

Returns:

the builder

custom

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

Deprecated. As of version 0.16.0, renamed to customString

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. 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

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. 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

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. Private attributes are not recorded in 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

customNumber

public LDUser.Builder customNumber(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.

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. Private attributes are not recorded in 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

build

public LDUser build()

Build the configured LDUser object

Returns:

the LDUser configured by this builder