Package com.dropbox.core.v2.team

Class UserSelectorArg

java.lang.Object

com.dropbox.core.v2.team.UserSelectorArg

public final class UserSelectorArg
extends Object

Argument for selecting a single user, either by team_member_id, external_id or email.

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 return true. You can use tag() to determine the tag associated with this instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserSelectorArg.Tag	Discriminating tag type for UserSelectorArg.

Method Summary

Modifier and Type	Method	Description
static UserSelectorArg	email(String value)	Returns an instance of UserSelectorArg that has its tag set to UserSelectorArg.Tag.EMAIL.
boolean	equals(Object obj)
static UserSelectorArg	externalId(String value)	Returns an instance of UserSelectorArg that has its tag set to UserSelectorArg.Tag.EXTERNAL_ID.
String	getEmailValue()	This instance must be tagged as UserSelectorArg.Tag.EMAIL.
String	getExternalIdValue()	This instance must be tagged as UserSelectorArg.Tag.EXTERNAL_ID.
String	getTeamMemberIdValue()	This instance must be tagged as UserSelectorArg.Tag.TEAM_MEMBER_ID.
int	hashCode()
boolean	isEmail()	Returns true if this instance has the tag UserSelectorArg.Tag.EMAIL, false otherwise.
boolean	isExternalId()	Returns true if this instance has the tag UserSelectorArg.Tag.EXTERNAL_ID, false otherwise.
boolean	isTeamMemberId()	Returns true if this instance has the tag UserSelectorArg.Tag.TEAM_MEMBER_ID, false otherwise.
UserSelectorArg.Tag	tag()	Returns the tag for this instance.
static UserSelectorArg	teamMemberId(String value)	Returns an instance of UserSelectorArg that has its tag set to UserSelectorArg.Tag.TEAM_MEMBER_ID.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

tag

public UserSelectorArg.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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this UserSelectorArg.

Returns:

the tag for this instance.

isTeamMemberId

public boolean isTeamMemberId()

Returns true if this instance has the tag UserSelectorArg.Tag.TEAM_MEMBER_ID, false otherwise.

Returns:

true if this instance is tagged as UserSelectorArg.Tag.TEAM_MEMBER_ID, false otherwise.

teamMemberId

public static UserSelectorArg teamMemberId(String value)

Returns an instance of UserSelectorArg that has its tag set to UserSelectorArg.Tag.TEAM_MEMBER_ID.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of UserSelectorArg with its tag set to UserSelectorArg.Tag.TEAM_MEMBER_ID.

Throws:

IllegalArgumentException - if value is null.

getTeamMemberIdValue

public String getTeamMemberIdValue()

This instance must be tagged as UserSelectorArg.Tag.TEAM_MEMBER_ID.

Returns:

The String value associated with this instance if isTeamMemberId() is true.

Throws:

IllegalStateException - If isTeamMemberId() is false.

isExternalId

public boolean isExternalId()

Returns true if this instance has the tag UserSelectorArg.Tag.EXTERNAL_ID, false otherwise.

Returns:

true if this instance is tagged as UserSelectorArg.Tag.EXTERNAL_ID, false otherwise.

externalId

public static UserSelectorArg externalId(String value)

Returns an instance of UserSelectorArg that has its tag set to UserSelectorArg.Tag.EXTERNAL_ID.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of UserSelectorArg with its tag set to UserSelectorArg.Tag.EXTERNAL_ID.

Throws:

IllegalArgumentException - if value is longer than 64 or is null.

getExternalIdValue

public String getExternalIdValue()

This instance must be tagged as UserSelectorArg.Tag.EXTERNAL_ID.

Returns:

The String value associated with this instance if isExternalId() is true.

Throws:

IllegalStateException - If isExternalId() is false.

isEmail

public boolean isEmail()

Returns true if this instance has the tag UserSelectorArg.Tag.EMAIL, false otherwise.

Returns:

true if this instance is tagged as UserSelectorArg.Tag.EMAIL, false otherwise.

email

public static UserSelectorArg email(String value)

Returns an instance of UserSelectorArg that has its tag set to UserSelectorArg.Tag.EMAIL.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of UserSelectorArg with its tag set to UserSelectorArg.Tag.EMAIL.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getEmailValue

public String getEmailValue()

This instance must be tagged as UserSelectorArg.Tag.EMAIL.

Returns:

The String value associated with this instance if isEmail() is true.

Throws:

IllegalStateException - If isEmail() is false.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public 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