Class FileMemberActionError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.FileMemberActionError
-
public final class FileMemberActionError 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
FileMemberActionError.Tag
Discriminating tag type forFileMemberActionError
.
-
Field Summary
Fields Modifier and Type Field Description static FileMemberActionError
INVALID_MEMBER
Specified member was not found.static FileMemberActionError
NO_PERMISSION
User does not have permission to perform this action on this member.static FileMemberActionError
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 FileMemberActionError
accessError(SharingFileAccessError value)
Returns an instance ofFileMemberActionError
that has its tag set toFileMemberActionError.Tag.ACCESS_ERROR
.boolean
equals(java.lang.Object obj)
SharingFileAccessError
getAccessErrorValue()
Specified file was invalid or user does not have access.MemberAccessLevelResult
getNoExplicitAccessValue()
The action cannot be completed because the target member does not have explicit access to the file.int
hashCode()
boolean
isAccessError()
boolean
isInvalidMember()
Returnstrue
if this instance has the tagFileMemberActionError.Tag.INVALID_MEMBER
,false
otherwise.boolean
isNoExplicitAccess()
Returnstrue
if this instance has the tagFileMemberActionError.Tag.NO_EXPLICIT_ACCESS
,false
otherwise.boolean
isNoPermission()
boolean
isOther()
static FileMemberActionError
noExplicitAccess(MemberAccessLevelResult value)
Returns an instance ofFileMemberActionError
that has its tag set toFileMemberActionError.Tag.NO_EXPLICIT_ACCESS
.FileMemberActionError.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
-
INVALID_MEMBER
public static final FileMemberActionError INVALID_MEMBER
Specified member was not found.
-
NO_PERMISSION
public static final FileMemberActionError NO_PERMISSION
User does not have permission to perform this action on this member.
-
OTHER
public static final FileMemberActionError 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 FileMemberActionError.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 thisFileMemberActionError
.If a tag returned by the server is unrecognized by this SDK, the
FileMemberActionError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isInvalidMember
public boolean isInvalidMember()
Returnstrue
if this instance has the tagFileMemberActionError.Tag.INVALID_MEMBER
,false
otherwise.- Returns:
true
if this instance is tagged asFileMemberActionError.Tag.INVALID_MEMBER
,false
otherwise.
-
isNoPermission
public boolean isNoPermission()
- Returns:
true
if this instance is tagged asFileMemberActionError.Tag.NO_PERMISSION
,false
otherwise.
-
isAccessError
public boolean isAccessError()
- Returns:
true
if this instance is tagged asFileMemberActionError.Tag.ACCESS_ERROR
,false
otherwise.
-
accessError
public static FileMemberActionError accessError(SharingFileAccessError value)
Returns an instance ofFileMemberActionError
that has its tag set toFileMemberActionError.Tag.ACCESS_ERROR
.Specified file was invalid or user does not have access.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
FileMemberActionError
with its tag set toFileMemberActionError.Tag.ACCESS_ERROR
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getAccessErrorValue
public SharingFileAccessError getAccessErrorValue()
Specified file was invalid or user does not have access.This instance must be tagged as
FileMemberActionError.Tag.ACCESS_ERROR
.- Returns:
- The
SharingFileAccessError
value associated with this instance ifisAccessError()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisAccessError()
isfalse
.
-
isNoExplicitAccess
public boolean isNoExplicitAccess()
Returnstrue
if this instance has the tagFileMemberActionError.Tag.NO_EXPLICIT_ACCESS
,false
otherwise.- Returns:
true
if this instance is tagged asFileMemberActionError.Tag.NO_EXPLICIT_ACCESS
,false
otherwise.
-
noExplicitAccess
public static FileMemberActionError noExplicitAccess(MemberAccessLevelResult value)
Returns an instance ofFileMemberActionError
that has its tag set toFileMemberActionError.Tag.NO_EXPLICIT_ACCESS
.The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
FileMemberActionError
with its tag set toFileMemberActionError.Tag.NO_EXPLICIT_ACCESS
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getNoExplicitAccessValue
public MemberAccessLevelResult getNoExplicitAccessValue()
The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.This instance must be tagged as
FileMemberActionError.Tag.NO_EXPLICIT_ACCESS
.- Returns:
- The
MemberAccessLevelResult
value associated with this instance ifisNoExplicitAccess()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisNoExplicitAccess()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asFileMemberActionError.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
-
-