Package com.dropbox.core.v2.sharing

Class MountFolderError

java.lang.Object

com.dropbox.core.v2.sharing.MountFolderError

public final class MountFolderError
extends Object

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

Field Summary

Fields

Modifier and Type	Field	Description
static final MountFolderError	ALREADY_MOUNTED	The shared folder is already mounted.
static final MountFolderError	INSIDE_SHARED_FOLDER	Mounting would cause a shared folder to be inside another, which is disallowed.
static final MountFolderError	MUST_AUTOMOUNT	The shared folder is not mountable by directly call APIs, instead the automounter is responsible for mounting it.
static final MountFolderError	NO_PERMISSION	The current user does not have permission to perform this action.
static final MountFolderError	NOT_MOUNTABLE	The shared folder is not mountable.
static final MountFolderError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static MountFolderError	accessError(SharedFolderAccessError value)	Returns an instance of MountFolderError that has its tag set to MountFolderError.Tag.ACCESS_ERROR.
boolean	equals(Object obj)
SharedFolderAccessError	getAccessErrorValue()	This instance must be tagged as MountFolderError.Tag.ACCESS_ERROR.
InsufficientQuotaAmounts	getInsufficientQuotaValue()	The current user does not have enough space to mount the shared folder.
int	hashCode()
static MountFolderError	insufficientQuota(InsufficientQuotaAmounts value)	Returns an instance of MountFolderError that has its tag set to MountFolderError.Tag.INSUFFICIENT_QUOTA.
boolean	isAccessError()	Returns true if this instance has the tag MountFolderError.Tag.ACCESS_ERROR, false otherwise.
boolean	isAlreadyMounted()	Returns true if this instance has the tag MountFolderError.Tag.ALREADY_MOUNTED, false otherwise.
boolean	isInsideSharedFolder()	Returns true if this instance has the tag MountFolderError.Tag.INSIDE_SHARED_FOLDER, false otherwise.
boolean	isInsufficientQuota()	Returns true if this instance has the tag MountFolderError.Tag.INSUFFICIENT_QUOTA, false otherwise.
boolean	isMustAutomount()	Returns true if this instance has the tag MountFolderError.Tag.MUST_AUTOMOUNT, false otherwise.
boolean	isNoPermission()	Returns true if this instance has the tag MountFolderError.Tag.NO_PERMISSION, false otherwise.
boolean	isNotMountable()	Returns true if this instance has the tag MountFolderError.Tag.NOT_MOUNTABLE, false otherwise.
boolean	isOther()	Returns true if this instance has the tag MountFolderError.Tag.OTHER, false otherwise.
MountFolderError.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

INSIDE_SHARED_FOLDER

public static final MountFolderError INSIDE_SHARED_FOLDER

Mounting would cause a shared folder to be inside another, which is disallowed.

ALREADY_MOUNTED

public static final MountFolderError ALREADY_MOUNTED

The shared folder is already mounted.

NO_PERMISSION

public static final MountFolderError NO_PERMISSION

The current user does not have permission to perform this action.

NOT_MOUNTABLE

public static final MountFolderError NOT_MOUNTABLE

The shared folder is not mountable. One example where this can occur is when the shared folder belongs within a team folder in the user's Dropbox.

MUST_AUTOMOUNT

public static final MountFolderError MUST_AUTOMOUNT

The shared folder is not mountable by directly call APIs, instead the automounter is responsible for mounting it.

OTHER

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

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

Returns:

the tag for this instance.

isAccessError

public boolean isAccessError()

Returns true if this instance has the tag MountFolderError.Tag.ACCESS_ERROR, false otherwise.

Returns:

true if this instance is tagged as MountFolderError.Tag.ACCESS_ERROR, false otherwise.

accessError

public static MountFolderError accessError(SharedFolderAccessError value)

Returns an instance of MountFolderError that has its tag set to MountFolderError.Tag.ACCESS_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of MountFolderError with its tag set to MountFolderError.Tag.ACCESS_ERROR.

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharedFolderAccessError getAccessErrorValue()

This instance must be tagged as MountFolderError.Tag.ACCESS_ERROR.

Returns:

The SharedFolderAccessError value associated with this instance if isAccessError() is true.

Throws:

IllegalStateException - If isAccessError() is false.

isInsideSharedFolder

public boolean isInsideSharedFolder()

Returns true if this instance has the tag MountFolderError.Tag.INSIDE_SHARED_FOLDER, false otherwise.

Returns:

true if this instance is tagged as MountFolderError.Tag.INSIDE_SHARED_FOLDER, false otherwise.

isInsufficientQuota

public boolean isInsufficientQuota()

Returns true if this instance has the tag MountFolderError.Tag.INSUFFICIENT_QUOTA, false otherwise.

Returns:

true if this instance is tagged as MountFolderError.Tag.INSUFFICIENT_QUOTA, false otherwise.

insufficientQuota

public static MountFolderError insufficientQuota(InsufficientQuotaAmounts value)

Returns an instance of MountFolderError that has its tag set to MountFolderError.Tag.INSUFFICIENT_QUOTA.

The current user does not have enough space to mount the shared folder.

Parameters:

value - value to assign to this instance.

Returns:

Instance of MountFolderError with its tag set to MountFolderError.Tag.INSUFFICIENT_QUOTA.

Throws:

IllegalArgumentException - if value is null.

getInsufficientQuotaValue

public InsufficientQuotaAmounts getInsufficientQuotaValue()

The current user does not have enough space to mount the shared folder.

This instance must be tagged as MountFolderError.Tag.INSUFFICIENT_QUOTA.

Returns:

The InsufficientQuotaAmounts value associated with this instance if isInsufficientQuota() is true.

Throws:

IllegalStateException - If isInsufficientQuota() is false.

isAlreadyMounted

public boolean isAlreadyMounted()

Returns true if this instance has the tag MountFolderError.Tag.ALREADY_MOUNTED, false otherwise.

Returns:

true if this instance is tagged as MountFolderError.Tag.ALREADY_MOUNTED, false otherwise.

isNoPermission

public boolean isNoPermission()

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

Returns:

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

isNotMountable

public boolean isNotMountable()

Returns true if this instance has the tag MountFolderError.Tag.NOT_MOUNTABLE, false otherwise.

Returns:

true if this instance is tagged as MountFolderError.Tag.NOT_MOUNTABLE, false otherwise.

isMustAutomount

public boolean isMustAutomount()

Returns true if this instance has the tag MountFolderError.Tag.MUST_AUTOMOUNT, false otherwise.

Returns:

true if this instance is tagged as MountFolderError.Tag.MUST_AUTOMOUNT, false otherwise.

isOther

public boolean isOther()

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

Returns:

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