Class RelinquishFolderMembershipError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.RelinquishFolderMembershipError
-
public final class RelinquishFolderMembershipError 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 classRelinquishFolderMembershipError.TagDiscriminating tag type forRelinquishFolderMembershipError.
-
Field Summary
Fields Modifier and Type Field Description static RelinquishFolderMembershipErrorFOLDER_OWNERThe current user is the owner of the shared folder.static RelinquishFolderMembershipErrorGROUP_ACCESSThe current user has access to the shared folder via a group.static RelinquishFolderMembershipErrorMOUNTEDThe shared folder is currently mounted.static RelinquishFolderMembershipErrorNO_EXPLICIT_ACCESSThe current user only has inherited access to the shared folder.static RelinquishFolderMembershipErrorNO_PERMISSIONThe current user does not have permission to perform this action.static RelinquishFolderMembershipErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static RelinquishFolderMembershipErrorTEAM_FOLDERThis action cannot be performed on a team shared folder.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RelinquishFolderMembershipErroraccessError(SharedFolderAccessError value)Returns an instance ofRelinquishFolderMembershipErrorthat has its tag set toRelinquishFolderMembershipError.Tag.ACCESS_ERROR.booleanequals(java.lang.Object obj)SharedFolderAccessErrorgetAccessErrorValue()This instance must be tagged asRelinquishFolderMembershipError.Tag.ACCESS_ERROR.inthashCode()booleanisAccessError()Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.ACCESS_ERROR,falseotherwise.booleanisFolderOwner()Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.FOLDER_OWNER,falseotherwise.booleanisGroupAccess()Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.GROUP_ACCESS,falseotherwise.booleanisMounted()Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.MOUNTED,falseotherwise.booleanisNoExplicitAccess()Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.NO_EXPLICIT_ACCESS,falseotherwise.booleanisNoPermission()Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.NO_PERMISSION,falseotherwise.booleanisOther()Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.OTHER,falseotherwise.booleanisTeamFolder()Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.TEAM_FOLDER,falseotherwise.RelinquishFolderMembershipError.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
-
FOLDER_OWNER
public static final RelinquishFolderMembershipError FOLDER_OWNER
The current user is the owner of the shared folder. Owners cannot relinquish membership to their own folders. Try unsharing or transferring ownership first.
-
MOUNTED
public static final RelinquishFolderMembershipError MOUNTED
The shared folder is currently mounted. Unmount the shared folder before relinquishing membership.
-
GROUP_ACCESS
public static final RelinquishFolderMembershipError GROUP_ACCESS
The current user has access to the shared folder via a group. You can't relinquish membership to folders shared via groups.
-
TEAM_FOLDER
public static final RelinquishFolderMembershipError TEAM_FOLDER
This action cannot be performed on a team shared folder.
-
NO_PERMISSION
public static final RelinquishFolderMembershipError NO_PERMISSION
The current user does not have permission to perform this action.
-
NO_EXPLICIT_ACCESS
public static final RelinquishFolderMembershipError NO_EXPLICIT_ACCESS
The current user only has inherited access to the shared folder. You can't relinquish inherited membership to folders.
-
OTHER
public static final RelinquishFolderMembershipError 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 RelinquishFolderMembershipError.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 thisRelinquishFolderMembershipError.If a tag returned by the server is unrecognized by this SDK, the
RelinquishFolderMembershipError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isAccessError
public boolean isAccessError()
Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.ACCESS_ERROR,falseotherwise.- Returns:
trueif this instance is tagged asRelinquishFolderMembershipError.Tag.ACCESS_ERROR,falseotherwise.
-
accessError
public static RelinquishFolderMembershipError accessError(SharedFolderAccessError value)
Returns an instance ofRelinquishFolderMembershipErrorthat has its tag set toRelinquishFolderMembershipError.Tag.ACCESS_ERROR.None
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
RelinquishFolderMembershipErrorwith its tag set toRelinquishFolderMembershipError.Tag.ACCESS_ERROR. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getAccessErrorValue
public SharedFolderAccessError getAccessErrorValue()
This instance must be tagged asRelinquishFolderMembershipError.Tag.ACCESS_ERROR.- Returns:
- The
SharedFolderAccessErrorvalue associated with this instance ifisAccessError()istrue. - Throws:
java.lang.IllegalStateException- IfisAccessError()isfalse.
-
isFolderOwner
public boolean isFolderOwner()
Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.FOLDER_OWNER,falseotherwise.- Returns:
trueif this instance is tagged asRelinquishFolderMembershipError.Tag.FOLDER_OWNER,falseotherwise.
-
isMounted
public boolean isMounted()
Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.MOUNTED,falseotherwise.- Returns:
trueif this instance is tagged asRelinquishFolderMembershipError.Tag.MOUNTED,falseotherwise.
-
isGroupAccess
public boolean isGroupAccess()
Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.GROUP_ACCESS,falseotherwise.- Returns:
trueif this instance is tagged asRelinquishFolderMembershipError.Tag.GROUP_ACCESS,falseotherwise.
-
isTeamFolder
public boolean isTeamFolder()
Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.TEAM_FOLDER,falseotherwise.- Returns:
trueif this instance is tagged asRelinquishFolderMembershipError.Tag.TEAM_FOLDER,falseotherwise.
-
isNoPermission
public boolean isNoPermission()
Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.NO_PERMISSION,falseotherwise.- Returns:
trueif this instance is tagged asRelinquishFolderMembershipError.Tag.NO_PERMISSION,falseotherwise.
-
isNoExplicitAccess
public boolean isNoExplicitAccess()
Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.NO_EXPLICIT_ACCESS,falseotherwise.- Returns:
trueif this instance is tagged asRelinquishFolderMembershipError.Tag.NO_EXPLICIT_ACCESS,falseotherwise.
-
isOther
public boolean isOther()
Returnstrueif this instance has the tagRelinquishFolderMembershipError.Tag.OTHER,falseotherwise.- Returns:
trueif this instance is tagged asRelinquishFolderMembershipError.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
-
-