Package com.dropbox.core.v2.sharing

Class UnmountFolderError

java.lang.Object

com.dropbox.core.v2.sharing.UnmountFolderError

public final class UnmountFolderError
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	UnmountFolderError.Tag	Discriminating tag type for UnmountFolderError.

Field Summary

Fields

Modifier and Type	Field	Description
static final UnmountFolderError	NO_PERMISSION	The current user does not have permission to perform this action.
static final UnmountFolderError	NOT_UNMOUNTABLE	The shared folder can't be unmounted.
static final UnmountFolderError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static UnmountFolderError	accessError(SharedFolderAccessError value)	Returns an instance of UnmountFolderError that has its tag set to UnmountFolderError.Tag.ACCESS_ERROR.
boolean	equals(Object obj)
SharedFolderAccessError	getAccessErrorValue()	This instance must be tagged as UnmountFolderError.Tag.ACCESS_ERROR.
int	hashCode()
boolean	isAccessError()	Returns true if this instance has the tag UnmountFolderError.Tag.ACCESS_ERROR, false otherwise.
boolean	isNoPermission()	Returns true if this instance has the tag UnmountFolderError.Tag.NO_PERMISSION, false otherwise.
boolean	isNotUnmountable()	Returns true if this instance has the tag UnmountFolderError.Tag.NOT_UNMOUNTABLE, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UnmountFolderError.Tag.OTHER, false otherwise.
UnmountFolderError.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

NO_PERMISSION

public static final UnmountFolderError NO_PERMISSION

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

NOT_UNMOUNTABLE

public static final UnmountFolderError NOT_UNMOUNTABLE

The shared folder can't be unmounted. One example where this can occur is when the shared folder's parent folder is also a shared folder that resides in the current user's Dropbox.

OTHER

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

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

Returns:

the tag for this instance.

isAccessError

public boolean isAccessError()

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

Returns:

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

accessError

public static UnmountFolderError accessError(SharedFolderAccessError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharedFolderAccessError getAccessErrorValue()

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

Returns:

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

Throws:

IllegalStateException - If isAccessError() is false.

isNoPermission

public boolean isNoPermission()

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

Returns:

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

isNotUnmountable

public boolean isNotUnmountable()

Returns true if this instance has the tag UnmountFolderError.Tag.NOT_UNMOUNTABLE, false otherwise.

Returns:

true if this instance is tagged as UnmountFolderError.Tag.NOT_UNMOUNTABLE, false otherwise.

isOther

public boolean isOther()

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

Returns:

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