Class UnshareFolderError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.UnshareFolderError
-
public final class UnshareFolderError 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 classUnshareFolderError.TagDiscriminating tag type forUnshareFolderError.
-
Field Summary
Fields Modifier and Type Field Description static UnshareFolderErrorNO_PERMISSIONThe current user does not have permission to perform this action.static UnshareFolderErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static UnshareFolderErrorTEAM_FOLDERThis action cannot be performed on a team shared folder.static UnshareFolderErrorTOO_MANY_FILESThis shared folder has too many files to be unshared.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UnshareFolderErroraccessError(SharedFolderAccessError value)Returns an instance ofUnshareFolderErrorthat has its tag set toUnshareFolderError.Tag.ACCESS_ERROR.booleanequals(java.lang.Object obj)SharedFolderAccessErrorgetAccessErrorValue()This instance must be tagged asUnshareFolderError.Tag.ACCESS_ERROR.inthashCode()booleanisAccessError()booleanisNoPermission()booleanisOther()booleanisTeamFolder()booleanisTooManyFiles()UnshareFolderError.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
-
TEAM_FOLDER
public static final UnshareFolderError TEAM_FOLDER
This action cannot be performed on a team shared folder.
-
NO_PERMISSION
public static final UnshareFolderError NO_PERMISSION
The current user does not have permission to perform this action.
-
TOO_MANY_FILES
public static final UnshareFolderError TOO_MANY_FILES
This shared folder has too many files to be unshared.
-
OTHER
public static final UnshareFolderError 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 UnshareFolderError.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 thisUnshareFolderError.If a tag returned by the server is unrecognized by this SDK, the
UnshareFolderError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isAccessError
public boolean isAccessError()
- Returns:
trueif this instance is tagged asUnshareFolderError.Tag.ACCESS_ERROR,falseotherwise.
-
accessError
public static UnshareFolderError accessError(SharedFolderAccessError value)
Returns an instance ofUnshareFolderErrorthat has its tag set toUnshareFolderError.Tag.ACCESS_ERROR.None
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
UnshareFolderErrorwith its tag set toUnshareFolderError.Tag.ACCESS_ERROR. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getAccessErrorValue
public SharedFolderAccessError getAccessErrorValue()
This instance must be tagged asUnshareFolderError.Tag.ACCESS_ERROR.- Returns:
- The
SharedFolderAccessErrorvalue associated with this instance ifisAccessError()istrue. - Throws:
java.lang.IllegalStateException- IfisAccessError()isfalse.
-
isTeamFolder
public boolean isTeamFolder()
- Returns:
trueif this instance is tagged asUnshareFolderError.Tag.TEAM_FOLDER,falseotherwise.
-
isNoPermission
public boolean isNoPermission()
- Returns:
trueif this instance is tagged asUnshareFolderError.Tag.NO_PERMISSION,falseotherwise.
-
isTooManyFiles
public boolean isTooManyFiles()
- Returns:
trueif this instance is tagged asUnshareFolderError.Tag.TOO_MANY_FILES,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asUnshareFolderError.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
-
-