Class MountFolderError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.MountFolderError
-
public final class MountFolderError extends java.lang.Object
This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of theisAbc()
methods will returntrue
. You can usetag()
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
MountFolderError.Tag
Discriminating tag type forMountFolderError
.
-
Field Summary
Fields Modifier and Type Field Description static MountFolderError
ALREADY_MOUNTED
The shared folder is already mounted.static MountFolderError
INSIDE_SHARED_FOLDER
Mounting would cause a shared folder to be inside another, which is disallowed.static MountFolderError
NO_PERMISSION
The current user does not have permission to perform this action.static MountFolderError
NOT_MOUNTABLE
The shared folder is not mountable.static MountFolderError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MountFolderError
accessError(SharedFolderAccessError value)
Returns an instance ofMountFolderError
that has its tag set toMountFolderError.Tag.ACCESS_ERROR
.boolean
equals(java.lang.Object obj)
SharedFolderAccessError
getAccessErrorValue()
This instance must be tagged asMountFolderError.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 ofMountFolderError
that has its tag set toMountFolderError.Tag.INSUFFICIENT_QUOTA
.boolean
isAccessError()
boolean
isAlreadyMounted()
boolean
isInsideSharedFolder()
Returnstrue
if this instance has the tagMountFolderError.Tag.INSIDE_SHARED_FOLDER
,false
otherwise.boolean
isInsufficientQuota()
boolean
isNoPermission()
boolean
isNotMountable()
boolean
isOther()
MountFolderError.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.
-
-
-
Field Detail
-
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.
-
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 Detail
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisMountFolderError
.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 is tagged asMountFolderError.Tag.ACCESS_ERROR
,false
otherwise.
-
accessError
public static MountFolderError accessError(SharedFolderAccessError value)
Returns an instance ofMountFolderError
that has its tag set toMountFolderError.Tag.ACCESS_ERROR
.None
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
MountFolderError
with its tag set toMountFolderError.Tag.ACCESS_ERROR
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getAccessErrorValue
public SharedFolderAccessError getAccessErrorValue()
This instance must be tagged asMountFolderError.Tag.ACCESS_ERROR
.- Returns:
- The
SharedFolderAccessError
value associated with this instance ifisAccessError()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisAccessError()
isfalse
.
-
isInsideSharedFolder
public boolean isInsideSharedFolder()
Returnstrue
if this instance has the tagMountFolderError.Tag.INSIDE_SHARED_FOLDER
,false
otherwise.- Returns:
true
if this instance is tagged asMountFolderError.Tag.INSIDE_SHARED_FOLDER
,false
otherwise.
-
isInsufficientQuota
public boolean isInsufficientQuota()
- Returns:
true
if this instance is tagged asMountFolderError.Tag.INSUFFICIENT_QUOTA
,false
otherwise.
-
insufficientQuota
public static MountFolderError insufficientQuota(InsufficientQuotaAmounts value)
Returns an instance ofMountFolderError
that has its tag set toMountFolderError.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 toMountFolderError.Tag.INSUFFICIENT_QUOTA
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisInsufficientQuota()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisInsufficientQuota()
isfalse
.
-
isAlreadyMounted
public boolean isAlreadyMounted()
- Returns:
true
if this instance is tagged asMountFolderError.Tag.ALREADY_MOUNTED
,false
otherwise.
-
isNoPermission
public boolean isNoPermission()
- Returns:
true
if this instance is tagged asMountFolderError.Tag.NO_PERMISSION
,false
otherwise.
-
isNotMountable
public boolean isNotMountable()
- Returns:
true
if this instance is tagged asMountFolderError.Tag.NOT_MOUNTABLE
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asMountFolderError.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.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
-
-