Package com.dropbox.core.v2.users

Class SpaceAllocation

java.lang.Object

com.dropbox.core.v2.users.SpaceAllocation

public final class SpaceAllocation
extends Object

Space is allocated differently based on the type of account.

This class is an open 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.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final SpaceAllocation	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
IndividualSpaceAllocation	getIndividualValue()	The user's space allocation applies only to their individual account.
TeamSpaceAllocation	getTeamValue()	The user shares space with other members of their team.
int	hashCode()
static SpaceAllocation	individual(IndividualSpaceAllocation value)	Returns an instance of SpaceAllocation that has its tag set to SpaceAllocation.Tag.INDIVIDUAL.
boolean	isIndividual()	Returns true if this instance has the tag SpaceAllocation.Tag.INDIVIDUAL, false otherwise.
boolean	isOther()	Returns true if this instance has the tag SpaceAllocation.Tag.OTHER, false otherwise.
boolean	isTeam()	Returns true if this instance has the tag SpaceAllocation.Tag.TEAM, false otherwise.
SpaceAllocation.Tag	tag()	Returns the tag for this instance.
static SpaceAllocation	team(TeamSpaceAllocation value)	Returns an instance of SpaceAllocation that has its tag set to SpaceAllocation.Tag.TEAM.
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

Field Details

OTHER

public static final SpaceAllocation OTHER

Catch-all used for unknown tag values returned by the Dropbox servers.

Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

Method Details

tag

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

If a tag returned by the server is unrecognized by this SDK, the SpaceAllocation.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isIndividual

public boolean isIndividual()

Returns true if this instance has the tag SpaceAllocation.Tag.INDIVIDUAL, false otherwise.

Returns:

true if this instance is tagged as SpaceAllocation.Tag.INDIVIDUAL, false otherwise.

individual

public static SpaceAllocation individual(IndividualSpaceAllocation value)

Returns an instance of SpaceAllocation that has its tag set to SpaceAllocation.Tag.INDIVIDUAL.

The user's space allocation applies only to their individual account.

Parameters:

value - value to assign to this instance.

Returns:

Instance of SpaceAllocation with its tag set to SpaceAllocation.Tag.INDIVIDUAL.

Throws:

IllegalArgumentException - if value is null.

getIndividualValue

public IndividualSpaceAllocation getIndividualValue()

The user's space allocation applies only to their individual account.

This instance must be tagged as SpaceAllocation.Tag.INDIVIDUAL.

Returns:

The IndividualSpaceAllocation value associated with this instance if isIndividual() is true.

Throws:

IllegalStateException - If isIndividual() is false.

isTeam

public boolean isTeam()

Returns true if this instance has the tag SpaceAllocation.Tag.TEAM, false otherwise.

Returns:

true if this instance is tagged as SpaceAllocation.Tag.TEAM, false otherwise.

team

public static SpaceAllocation team(TeamSpaceAllocation value)

Returns an instance of SpaceAllocation that has its tag set to SpaceAllocation.Tag.TEAM.

The user shares space with other members of their team.

Parameters:

value - value to assign to this instance.

Returns:

Instance of SpaceAllocation with its tag set to SpaceAllocation.Tag.TEAM.

Throws:

IllegalArgumentException - if value is null.

getTeamValue

public TeamSpaceAllocation getTeamValue()

The user shares space with other members of their team.

This instance must be tagged as SpaceAllocation.Tag.TEAM.

Returns:

The TeamSpaceAllocation value associated with this instance if isTeam() is true.

Throws:

IllegalStateException - If isTeam() is false.

isOther

public boolean isOther()

Returns true if this instance has the tag SpaceAllocation.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as SpaceAllocation.Tag.OTHER, false otherwise.

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