Package com.dropbox.core.v2.auth

Class AccessError

java.lang.Object

com.dropbox.core.v2.auth.AccessError

public final class AccessError
extends Object

Error occurred because the account doesn't have permission to access the resource.

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	AccessError.Serializer	For internal use only.
static enum	AccessError.Tag	Discriminating tag type for AccessError.

Field Summary

Fields

Modifier and Type	Field	Description
static final AccessError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final AccessError	TEAM_ACCESS_DENIED	Team doesn't have permission to access.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
InvalidAccountTypeError	getInvalidAccountTypeValue()	Current account type cannot access the resource.
NoPermissionError	getNoPermissionValue()	Caller does not have permission to access the resource.
PaperAccessError	getPaperAccessDeniedValue()	Current account cannot access Paper.
int	hashCode()
static AccessError	invalidAccountType(InvalidAccountTypeError value)	Returns an instance of AccessError that has its tag set to AccessError.Tag.INVALID_ACCOUNT_TYPE.
boolean	isInvalidAccountType()	Returns true if this instance has the tag AccessError.Tag.INVALID_ACCOUNT_TYPE, false otherwise.
boolean	isNoPermission()	Returns true if this instance has the tag AccessError.Tag.NO_PERMISSION, false otherwise.
boolean	isOther()	Returns true if this instance has the tag AccessError.Tag.OTHER, false otherwise.
boolean	isPaperAccessDenied()	Returns true if this instance has the tag AccessError.Tag.PAPER_ACCESS_DENIED, false otherwise.
boolean	isTeamAccessDenied()	Returns true if this instance has the tag AccessError.Tag.TEAM_ACCESS_DENIED, false otherwise.
static AccessError	noPermission(NoPermissionError value)	Returns an instance of AccessError that has its tag set to AccessError.Tag.NO_PERMISSION.
static AccessError	paperAccessDenied(PaperAccessError value)	Returns an instance of AccessError that has its tag set to AccessError.Tag.PAPER_ACCESS_DENIED.
AccessError.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

Field Details

TEAM_ACCESS_DENIED

public static final AccessError TEAM_ACCESS_DENIED

Team doesn't have permission to access.

OTHER

public static final AccessError 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 AccessError.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 AccessError.

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

Returns:

the tag for this instance.

isInvalidAccountType

public boolean isInvalidAccountType()

Returns true if this instance has the tag AccessError.Tag.INVALID_ACCOUNT_TYPE, false otherwise.

Returns:

true if this instance is tagged as AccessError.Tag.INVALID_ACCOUNT_TYPE, false otherwise.

invalidAccountType

public static AccessError invalidAccountType(InvalidAccountTypeError value)

Returns an instance of AccessError that has its tag set to AccessError.Tag.INVALID_ACCOUNT_TYPE.

Current account type cannot access the resource.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AccessError with its tag set to AccessError.Tag.INVALID_ACCOUNT_TYPE.

Throws:

IllegalArgumentException - if value is null.

getInvalidAccountTypeValue

public InvalidAccountTypeError getInvalidAccountTypeValue()

Current account type cannot access the resource.

This instance must be tagged as AccessError.Tag.INVALID_ACCOUNT_TYPE.

Returns:

The InvalidAccountTypeError value associated with this instance if isInvalidAccountType() is true.

Throws:

IllegalStateException - If isInvalidAccountType() is false.

isPaperAccessDenied

public boolean isPaperAccessDenied()

Returns true if this instance has the tag AccessError.Tag.PAPER_ACCESS_DENIED, false otherwise.

Returns:

true if this instance is tagged as AccessError.Tag.PAPER_ACCESS_DENIED, false otherwise.

paperAccessDenied

public static AccessError paperAccessDenied(PaperAccessError value)

Returns an instance of AccessError that has its tag set to AccessError.Tag.PAPER_ACCESS_DENIED.

Current account cannot access Paper.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AccessError with its tag set to AccessError.Tag.PAPER_ACCESS_DENIED.

Throws:

IllegalArgumentException - if value is null.

getPaperAccessDeniedValue

public PaperAccessError getPaperAccessDeniedValue()

Current account cannot access Paper.

This instance must be tagged as AccessError.Tag.PAPER_ACCESS_DENIED.

Returns:

The PaperAccessError value associated with this instance if isPaperAccessDenied() is true.

Throws:

IllegalStateException - If isPaperAccessDenied() is false.

isTeamAccessDenied

public boolean isTeamAccessDenied()

Returns true if this instance has the tag AccessError.Tag.TEAM_ACCESS_DENIED, false otherwise.

Returns:

true if this instance is tagged as AccessError.Tag.TEAM_ACCESS_DENIED, false otherwise.

isNoPermission

public boolean isNoPermission()

Returns true if this instance has the tag AccessError.Tag.NO_PERMISSION, false otherwise.

Returns:

true if this instance is tagged as AccessError.Tag.NO_PERMISSION, false otherwise.

noPermission

public static AccessError noPermission(NoPermissionError value)

Returns an instance of AccessError that has its tag set to AccessError.Tag.NO_PERMISSION.

Caller does not have permission to access the resource.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AccessError with its tag set to AccessError.Tag.NO_PERMISSION.

Throws:

IllegalArgumentException - if value is null.

getNoPermissionValue

public NoPermissionError getNoPermissionValue()

Caller does not have permission to access the resource.

This instance must be tagged as AccessError.Tag.NO_PERMISSION.

Returns:

The NoPermissionError value associated with this instance if isNoPermission() is true.

Throws:

IllegalStateException - If isNoPermission() is false.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as AccessError.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