Package com.dropbox.core.v2.team

Class GroupsSelector

java.lang.Object

com.dropbox.core.v2.team.GroupsSelector

public final class GroupsSelector
extends Object

Argument for selecting a list of groups, either by group_ids, or external group IDs.

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	GroupsSelector.Tag	Discriminating tag type for GroupsSelector.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<String>	getGroupExternalIdsValue()	List of external IDs of groups.
List<String>	getGroupIdsValue()	List of group IDs.
static GroupsSelector	groupExternalIds(List<String> value)	Returns an instance of GroupsSelector that has its tag set to GroupsSelector.Tag.GROUP_EXTERNAL_IDS.
static GroupsSelector	groupIds(List<String> value)	Returns an instance of GroupsSelector that has its tag set to GroupsSelector.Tag.GROUP_IDS.
int	hashCode()
boolean	isGroupExternalIds()	Returns true if this instance has the tag GroupsSelector.Tag.GROUP_EXTERNAL_IDS, false otherwise.
boolean	isGroupIds()	Returns true if this instance has the tag GroupsSelector.Tag.GROUP_IDS, false otherwise.
GroupsSelector.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 Details

tag

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

Returns:

the tag for this instance.

isGroupIds

public boolean isGroupIds()

Returns true if this instance has the tag GroupsSelector.Tag.GROUP_IDS, false otherwise.

Returns:

true if this instance is tagged as GroupsSelector.Tag.GROUP_IDS, false otherwise.

groupIds

public static GroupsSelector groupIds(List<String> value)

Returns an instance of GroupsSelector that has its tag set to GroupsSelector.Tag.GROUP_IDS.

List of group IDs.

Parameters:

value - value to assign to this instance.

Returns:

Instance of GroupsSelector with its tag set to GroupsSelector.Tag.GROUP_IDS.

Throws:

IllegalArgumentException - if value contains a null item or is null.

getGroupIdsValue

public List<String> getGroupIdsValue()

List of group IDs.

This instance must be tagged as GroupsSelector.Tag.GROUP_IDS.

Returns:

The List value associated with this instance if isGroupIds() is true.

Throws:

IllegalStateException - If isGroupIds() is false.

isGroupExternalIds

public boolean isGroupExternalIds()

Returns true if this instance has the tag GroupsSelector.Tag.GROUP_EXTERNAL_IDS, false otherwise.

Returns:

true if this instance is tagged as GroupsSelector.Tag.GROUP_EXTERNAL_IDS, false otherwise.

groupExternalIds

public static GroupsSelector groupExternalIds(List<String> value)

Returns an instance of GroupsSelector that has its tag set to GroupsSelector.Tag.GROUP_EXTERNAL_IDS.

List of external IDs of groups.

Parameters:

value - value to assign to this instance.

Returns:

Instance of GroupsSelector with its tag set to GroupsSelector.Tag.GROUP_EXTERNAL_IDS.

Throws:

IllegalArgumentException - if value contains a null item or is null.

getGroupExternalIdsValue

public List<String> getGroupExternalIdsValue()

List of external IDs of groups.

This instance must be tagged as GroupsSelector.Tag.GROUP_EXTERNAL_IDS.

Returns:

The List value associated with this instance if isGroupExternalIds() is true.

Throws:

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