Package com.launchdarkly.sdk
Class UserAttribute
- java.lang.Object
-
- com.launchdarkly.sdk.UserAttribute
-
- All Implemented Interfaces:
JsonSerializable
public final class UserAttribute extends java.lang.Object implements JsonSerializable
Represents a built-in or custom attribute name supported byLDUser
.This abstraction helps to distinguish attribute names from other
String
values, and also improves efficiency in feature flag data structures and evaluations because built-in attributes always reuse the same instances.For a fuller description of user attributes and how they can be referenced in feature flag rules, see the reference guides on Setting user attributes and Targeting users.
-
-
Field Summary
Fields Modifier and Type Field Description static UserAttribute
ANONYMOUS
Represents the anonymous attribute.static UserAttribute
AVATAR
Represents the avatar URL attribute.static UserAttribute
COUNTRY
Represents the country attribute.static UserAttribute
EMAIL
Represents the user key attribute.static UserAttribute
FIRST_NAME
Represents the first name attribute.static UserAttribute
IP
Represents the IP address attribute.static UserAttribute
KEY
Represents the user key attribute.static UserAttribute
LAST_NAME
Represents the last name attribute.static UserAttribute
NAME
Represents the full name attribute.static UserAttribute
SECONDARY_KEY
Represents the secondary key attribute.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object other)
static UserAttribute
forName(java.lang.String name)
Returns a UserAttribute instance for the specified attribute name.java.lang.String
getName()
Returns the case-sensitive attribute name.int
hashCode()
boolean
isBuiltIn()
Returns true for a built-in attribute or false for a custom attribute.java.lang.String
toString()
-
-
-
Field Detail
-
KEY
public static final UserAttribute KEY
Represents the user key attribute.
-
SECONDARY_KEY
public static final UserAttribute SECONDARY_KEY
Represents the secondary key attribute.
-
IP
public static final UserAttribute IP
Represents the IP address attribute.
-
EMAIL
public static final UserAttribute EMAIL
Represents the user key attribute.
-
NAME
public static final UserAttribute NAME
Represents the full name attribute.
-
AVATAR
public static final UserAttribute AVATAR
Represents the avatar URL attribute.
-
FIRST_NAME
public static final UserAttribute FIRST_NAME
Represents the first name attribute.
-
LAST_NAME
public static final UserAttribute LAST_NAME
Represents the last name attribute.
-
COUNTRY
public static final UserAttribute COUNTRY
Represents the country attribute.
-
ANONYMOUS
public static final UserAttribute ANONYMOUS
Represents the anonymous attribute.
-
-
Method Detail
-
forName
public static UserAttribute forName(java.lang.String name)
Returns a UserAttribute instance for the specified attribute name.For built-in attributes, the same instances are always reused and
isBuiltIn()
will return true. For custom attributes, a new instance is created andisBuiltIn()
will return false.- Parameters:
name
- the attribute name- Returns:
- a
UserAttribute
-
getName
public java.lang.String getName()
Returns the case-sensitive attribute name.- Returns:
- the attribute name
-
isBuiltIn
public boolean isBuiltIn()
Returns true for a built-in attribute or false for a custom attribute.- Returns:
- true if it is a built-in attribute
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-