Class TeamMemberStatus
- java.lang.Object
-
- com.dropbox.core.v2.team.TeamMemberStatus
-
public final class TeamMemberStatus extends java.lang.Object
The user's status as a member of a specific team.This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the
isAbc()
methods will returntrue
. You can usetag()
to determine the tag associated with this instance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TeamMemberStatus.Tag
Discriminating tag type forTeamMemberStatus
.
-
Field Summary
Fields Modifier and Type Field Description static TeamMemberStatus
ACTIVE
User has successfully joined the team.static TeamMemberStatus
INVITED
User has been invited to a team, but has not joined the team yet.static TeamMemberStatus
SUSPENDED
User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
RemovedStatus
getRemovedValue()
User is no longer a member of the team.int
hashCode()
boolean
isActive()
boolean
isInvited()
boolean
isRemoved()
boolean
isSuspended()
static TeamMemberStatus
removed(RemovedStatus value)
Returns an instance ofTeamMemberStatus
that has its tag set toTeamMemberStatus.Tag.REMOVED
.TeamMemberStatus.Tag
tag()
Returns the tag for this instance.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
ACTIVE
public static final TeamMemberStatus ACTIVE
User has successfully joined the team.
-
INVITED
public static final TeamMemberStatus INVITED
User has been invited to a team, but has not joined the team yet.
-
SUSPENDED
public static final TeamMemberStatus SUSPENDED
User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
-
-
Method Detail
-
tag
public TeamMemberStatus.Tag tag()
Returns the tag for this instance.This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the
isXyz()
methods will returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisTeamMemberStatus
.- Returns:
- the tag for this instance.
-
isActive
public boolean isActive()
- Returns:
true
if this instance is tagged asTeamMemberStatus.Tag.ACTIVE
,false
otherwise.
-
isInvited
public boolean isInvited()
- Returns:
true
if this instance is tagged asTeamMemberStatus.Tag.INVITED
,false
otherwise.
-
isSuspended
public boolean isSuspended()
- Returns:
true
if this instance is tagged asTeamMemberStatus.Tag.SUSPENDED
,false
otherwise.
-
isRemoved
public boolean isRemoved()
- Returns:
true
if this instance is tagged asTeamMemberStatus.Tag.REMOVED
,false
otherwise.
-
removed
public static TeamMemberStatus removed(RemovedStatus value)
Returns an instance ofTeamMemberStatus
that has its tag set toTeamMemberStatus.Tag.REMOVED
.User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
TeamMemberStatus
with its tag set toTeamMemberStatus.Tag.REMOVED
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getRemovedValue
public RemovedStatus getRemovedValue()
User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.This instance must be tagged as
TeamMemberStatus.Tag.REMOVED
.- Returns:
- The
RemovedStatus
value associated with this instance ifisRemoved()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisRemoved()
isfalse
.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
toStringMultiline
public java.lang.String toStringMultiline()
Returns a String representation of this object formatted for easier readability.The returned String may contain newlines.
- Returns:
- Formatted, multiline String representation of this object
-
-