Class RelinquishFolderMembershipError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.RelinquishFolderMembershipError
-
public final class RelinquishFolderMembershipError 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
RelinquishFolderMembershipError.Tag
Discriminating tag type forRelinquishFolderMembershipError
.
-
Field Summary
Fields Modifier and Type Field Description static RelinquishFolderMembershipError
FOLDER_OWNER
The current user is the owner of the shared folder.static RelinquishFolderMembershipError
GROUP_ACCESS
The current user has access to the shared folder via a group.static RelinquishFolderMembershipError
MOUNTED
The shared folder is currently mounted.static RelinquishFolderMembershipError
NO_EXPLICIT_ACCESS
The current user only has inherited access to the shared folder.static RelinquishFolderMembershipError
NO_PERMISSION
The current user does not have permission to perform this action.static RelinquishFolderMembershipError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static RelinquishFolderMembershipError
TEAM_FOLDER
This 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 RelinquishFolderMembershipError
accessError(SharedFolderAccessError value)
Returns an instance ofRelinquishFolderMembershipError
that has its tag set toRelinquishFolderMembershipError.Tag.ACCESS_ERROR
.boolean
equals(java.lang.Object obj)
SharedFolderAccessError
getAccessErrorValue()
This instance must be tagged asRelinquishFolderMembershipError.Tag.ACCESS_ERROR
.int
hashCode()
boolean
isAccessError()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.ACCESS_ERROR
,false
otherwise.boolean
isFolderOwner()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.FOLDER_OWNER
,false
otherwise.boolean
isGroupAccess()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.GROUP_ACCESS
,false
otherwise.boolean
isMounted()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.MOUNTED
,false
otherwise.boolean
isNoExplicitAccess()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.NO_EXPLICIT_ACCESS
,false
otherwise.boolean
isNoPermission()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.NO_PERMISSION
,false
otherwise.boolean
isOther()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.OTHER
,false
otherwise.boolean
isTeamFolder()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.TEAM_FOLDER
,false
otherwise.RelinquishFolderMembershipError.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
-
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 aswitch
statement to properly handle the different values for thisRelinquishFolderMembershipError
.If a tag returned by the server is unrecognized by this SDK, the
RelinquishFolderMembershipError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isAccessError
public boolean isAccessError()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.ACCESS_ERROR
,false
otherwise.- Returns:
true
if this instance is tagged asRelinquishFolderMembershipError.Tag.ACCESS_ERROR
,false
otherwise.
-
accessError
public static RelinquishFolderMembershipError accessError(SharedFolderAccessError value)
Returns an instance ofRelinquishFolderMembershipError
that has its tag set toRelinquishFolderMembershipError.Tag.ACCESS_ERROR
.None
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
RelinquishFolderMembershipError
with its tag set toRelinquishFolderMembershipError.Tag.ACCESS_ERROR
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getAccessErrorValue
public SharedFolderAccessError getAccessErrorValue()
This instance must be tagged asRelinquishFolderMembershipError.Tag.ACCESS_ERROR
.- Returns:
- The
SharedFolderAccessError
value associated with this instance ifisAccessError()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisAccessError()
isfalse
.
-
isFolderOwner
public boolean isFolderOwner()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.FOLDER_OWNER
,false
otherwise.- Returns:
true
if this instance is tagged asRelinquishFolderMembershipError.Tag.FOLDER_OWNER
,false
otherwise.
-
isMounted
public boolean isMounted()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.MOUNTED
,false
otherwise.- Returns:
true
if this instance is tagged asRelinquishFolderMembershipError.Tag.MOUNTED
,false
otherwise.
-
isGroupAccess
public boolean isGroupAccess()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.GROUP_ACCESS
,false
otherwise.- Returns:
true
if this instance is tagged asRelinquishFolderMembershipError.Tag.GROUP_ACCESS
,false
otherwise.
-
isTeamFolder
public boolean isTeamFolder()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.TEAM_FOLDER
,false
otherwise.- Returns:
true
if this instance is tagged asRelinquishFolderMembershipError.Tag.TEAM_FOLDER
,false
otherwise.
-
isNoPermission
public boolean isNoPermission()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.NO_PERMISSION
,false
otherwise.- Returns:
true
if this instance is tagged asRelinquishFolderMembershipError.Tag.NO_PERMISSION
,false
otherwise.
-
isNoExplicitAccess
public boolean isNoExplicitAccess()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.NO_EXPLICIT_ACCESS
,false
otherwise.- Returns:
true
if this instance is tagged asRelinquishFolderMembershipError.Tag.NO_EXPLICIT_ACCESS
,false
otherwise.
-
isOther
public boolean isOther()
Returnstrue
if this instance has the tagRelinquishFolderMembershipError.Tag.OTHER
,false
otherwise.- Returns:
true
if this instance is tagged asRelinquishFolderMembershipError.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
-
-