Class MountFolderError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.MountFolderError
-
public final class MountFolderError extends java.lang.ObjectThis 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
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMountFolderError.TagDiscriminating tag type forMountFolderError.
-
Field Summary
Fields Modifier and Type Field Description static MountFolderErrorALREADY_MOUNTEDThe shared folder is already mounted.static MountFolderErrorINSIDE_SHARED_FOLDERMounting would cause a shared folder to be inside another, which is disallowed.static MountFolderErrorNO_PERMISSIONThe current user does not have permission to perform this action.static MountFolderErrorNOT_MOUNTABLEThe shared folder is not mountable.static MountFolderErrorOTHERCatch-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 MountFolderErroraccessError(SharedFolderAccessError value)Returns an instance ofMountFolderErrorthat has its tag set toMountFolderError.Tag.ACCESS_ERROR.booleanequals(java.lang.Object obj)SharedFolderAccessErrorgetAccessErrorValue()This instance must be tagged asMountFolderError.Tag.ACCESS_ERROR.InsufficientQuotaAmountsgetInsufficientQuotaValue()The current user does not have enough space to mount the shared folder.inthashCode()static MountFolderErrorinsufficientQuota(InsufficientQuotaAmounts value)Returns an instance ofMountFolderErrorthat has its tag set toMountFolderError.Tag.INSUFFICIENT_QUOTA.booleanisAccessError()booleanisAlreadyMounted()booleanisInsideSharedFolder()Returnstrueif this instance has the tagMountFolderError.Tag.INSIDE_SHARED_FOLDER,falseotherwise.booleanisInsufficientQuota()booleanisNoPermission()booleanisNotMountable()booleanisOther()MountFolderError.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()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 aswitchstatement to properly handle the different values for thisMountFolderError.If a tag returned by the server is unrecognized by this SDK, the
MountFolderError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isAccessError
public boolean isAccessError()
- Returns:
trueif this instance is tagged asMountFolderError.Tag.ACCESS_ERROR,falseotherwise.
-
accessError
public static MountFolderError accessError(SharedFolderAccessError value)
Returns an instance ofMountFolderErrorthat has its tag set toMountFolderError.Tag.ACCESS_ERROR.None
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
MountFolderErrorwith its tag set toMountFolderError.Tag.ACCESS_ERROR. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getAccessErrorValue
public SharedFolderAccessError getAccessErrorValue()
This instance must be tagged asMountFolderError.Tag.ACCESS_ERROR.- Returns:
- The
SharedFolderAccessErrorvalue associated with this instance ifisAccessError()istrue. - Throws:
java.lang.IllegalStateException- IfisAccessError()isfalse.
-
isInsideSharedFolder
public boolean isInsideSharedFolder()
Returnstrueif this instance has the tagMountFolderError.Tag.INSIDE_SHARED_FOLDER,falseotherwise.- Returns:
trueif this instance is tagged asMountFolderError.Tag.INSIDE_SHARED_FOLDER,falseotherwise.
-
isInsufficientQuota
public boolean isInsufficientQuota()
- Returns:
trueif this instance is tagged asMountFolderError.Tag.INSUFFICIENT_QUOTA,falseotherwise.
-
insufficientQuota
public static MountFolderError insufficientQuota(InsufficientQuotaAmounts value)
Returns an instance ofMountFolderErrorthat 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
MountFolderErrorwith its tag set toMountFolderError.Tag.INSUFFICIENT_QUOTA. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
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
InsufficientQuotaAmountsvalue associated with this instance ifisInsufficientQuota()istrue. - Throws:
java.lang.IllegalStateException- IfisInsufficientQuota()isfalse.
-
isAlreadyMounted
public boolean isAlreadyMounted()
- Returns:
trueif this instance is tagged asMountFolderError.Tag.ALREADY_MOUNTED,falseotherwise.
-
isNoPermission
public boolean isNoPermission()
- Returns:
trueif this instance is tagged asMountFolderError.Tag.NO_PERMISSION,falseotherwise.
-
isNotMountable
public boolean isNotMountable()
- Returns:
trueif this instance is tagged asMountFolderError.Tag.NOT_MOUNTABLE,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asMountFolderError.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin 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
-
-