Package com.dropbox.core.v2.team

Class CustomQuotaResult

java.lang.Object

com.dropbox.core.v2.team.CustomQuotaResult

public final class CustomQuotaResult
extends java.lang.Object

User custom quota.

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
UserSelectorArg	getInvalidUserValue()	Invalid user (not in team).
UserCustomQuotaResult	getSuccessValue()	User's custom quota.
int	hashCode()
static CustomQuotaResult	invalidUser(UserSelectorArg value)	Returns an instance of CustomQuotaResult that has its tag set to CustomQuotaResult.Tag.INVALID_USER.
boolean	isInvalidUser()	Returns true if this instance has the tag CustomQuotaResult.Tag.INVALID_USER, false otherwise.
boolean	isOther()	Returns true if this instance has the tag CustomQuotaResult.Tag.OTHER, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag CustomQuotaResult.Tag.SUCCESS, false otherwise.
static CustomQuotaResult	success(UserCustomQuotaResult value)	Returns an instance of CustomQuotaResult that has its tag set to CustomQuotaResult.Tag.SUCCESS.
CustomQuotaResult.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.

Methods inherited from class java.lang.Object

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

Field Detail

OTHER

public static final CustomQuotaResult 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 Detail

tag

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

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

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

Returns true if this instance has the tag CustomQuotaResult.Tag.SUCCESS, false otherwise.

Returns:

true if this instance is tagged as CustomQuotaResult.Tag.SUCCESS, false otherwise.

success

public static CustomQuotaResult success(UserCustomQuotaResult value)

Returns an instance of CustomQuotaResult that has its tag set to CustomQuotaResult.Tag.SUCCESS.

User's custom quota.

Parameters:

value - value to assign to this instance.

Returns:

Instance of CustomQuotaResult with its tag set to CustomQuotaResult.Tag.SUCCESS.

Throws:

java.lang.IllegalArgumentException - if value is null.

getSuccessValue

public UserCustomQuotaResult getSuccessValue()

User's custom quota.

This instance must be tagged as CustomQuotaResult.Tag.SUCCESS.

Returns:

The UserCustomQuotaResult value associated with this instance if isSuccess() is true.

Throws:

java.lang.IllegalStateException - If isSuccess() is false.

isInvalidUser

public boolean isInvalidUser()

Returns true if this instance has the tag CustomQuotaResult.Tag.INVALID_USER, false otherwise.

Returns:

true if this instance is tagged as CustomQuotaResult.Tag.INVALID_USER, false otherwise.

invalidUser

public static CustomQuotaResult invalidUser(UserSelectorArg value)

Returns an instance of CustomQuotaResult that has its tag set to CustomQuotaResult.Tag.INVALID_USER.

Invalid user (not in team).

Parameters:

value - value to assign to this instance.

Returns:

Instance of CustomQuotaResult with its tag set to CustomQuotaResult.Tag.INVALID_USER.

Throws:

java.lang.IllegalArgumentException - if value is null.

getInvalidUserValue

public UserSelectorArg getInvalidUserValue()

Invalid user (not in team).

This instance must be tagged as CustomQuotaResult.Tag.INVALID_USER.

Returns:

The UserSelectorArg value associated with this instance if isInvalidUser() is true.

Throws:

java.lang.IllegalStateException - If isInvalidUser() is false.

isOther

public boolean isOther()

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

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.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