com.dropbox.core.v2.team

Class GroupSelector

java.lang.Object

com.dropbox.core.v2.team.GroupSelector

public final class GroupSelector
extends Object

Argument for selecting a single group, either by group_id or by external group ID.

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 and Description
static class	GroupSelector.Tag Discriminating tag type for GroupSelector.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getGroupExternalIdValue() External ID of the group.
String	getGroupIdValue() Group ID.
static GroupSelector	groupExternalId(String value) Returns an instance of GroupSelector that has its tag set to GroupSelector.Tag.GROUP_EXTERNAL_ID.
static GroupSelector	groupId(String value) Returns an instance of GroupSelector that has its tag set to GroupSelector.Tag.GROUP_ID.
int	hashCode()
boolean	isGroupExternalId() Returns true if this instance has the tag GroupSelector.Tag.GROUP_EXTERNAL_ID, false otherwise.
boolean	isGroupId() Returns true if this instance has the tag GroupSelector.Tag.GROUP_ID, false otherwise.
GroupSelector.Tag	tag() Returns the tag for this instance.
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 Detail

tag

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

Returns:

the tag for this instance.

isGroupId

public boolean isGroupId()

Returns true if this instance has the tag GroupSelector.Tag.GROUP_ID, false otherwise.

Returns:

true if this instance is tagged as GroupSelector.Tag.GROUP_ID, false otherwise.

groupId

public static GroupSelector groupId(String value)

Returns an instance of GroupSelector that has its tag set to GroupSelector.Tag.GROUP_ID.

Group ID.

Parameters:

value - value to assign to this instance.

Returns:

Instance of GroupSelector with its tag set to GroupSelector.Tag.GROUP_ID.

Throws:

IllegalArgumentException - if value is null.

getGroupIdValue

public String getGroupIdValue()

Group ID.

This instance must be tagged as GroupSelector.Tag.GROUP_ID.

Returns:

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

Throws:

IllegalStateException - If isGroupId() is false.

isGroupExternalId

public boolean isGroupExternalId()

Returns true if this instance has the tag GroupSelector.Tag.GROUP_EXTERNAL_ID, false otherwise.

Returns:

true if this instance is tagged as GroupSelector.Tag.GROUP_EXTERNAL_ID, false otherwise.

groupExternalId

public static GroupSelector groupExternalId(String value)

Returns an instance of GroupSelector that has its tag set to GroupSelector.Tag.GROUP_EXTERNAL_ID.

External ID of the group.

Parameters:

value - value to assign to this instance.

Returns:

Instance of GroupSelector with its tag set to GroupSelector.Tag.GROUP_EXTERNAL_ID.

Throws:

IllegalArgumentException - if value is null.

getGroupExternalIdValue

public String getGroupExternalIdValue()

External ID of the group.

This instance must be tagged as GroupSelector.Tag.GROUP_EXTERNAL_ID.

Returns:

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

Throws:

IllegalStateException - If isGroupExternalId() 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