Class FileMemberActionIndividualResult
- java.lang.Object
-
- com.dropbox.core.v2.sharing.FileMemberActionIndividualResult
-
public final class FileMemberActionIndividualResult extends java.lang.Object
This class is a 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FileMemberActionIndividualResult.Tag
Discriminating tag type forFileMemberActionIndividualResult
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
FileMemberActionError
getMemberErrorValue()
User was not able to perform this action.AccessLevel
getSuccessValue()
Member was successfully removed from this file.int
hashCode()
boolean
isMemberError()
Returnstrue
if this instance has the tagFileMemberActionIndividualResult.Tag.MEMBER_ERROR
,false
otherwise.boolean
isSuccess()
Returnstrue
if this instance has the tagFileMemberActionIndividualResult.Tag.SUCCESS
,false
otherwise.static FileMemberActionIndividualResult
memberError(FileMemberActionError value)
Returns an instance ofFileMemberActionIndividualResult
that has its tag set toFileMemberActionIndividualResult.Tag.MEMBER_ERROR
.static FileMemberActionIndividualResult
success()
Returns an instance ofFileMemberActionIndividualResult
that has its tag set toFileMemberActionIndividualResult.Tag.SUCCESS
.static FileMemberActionIndividualResult
success(AccessLevel value)
Returns an instance ofFileMemberActionIndividualResult
that has its tag set toFileMemberActionIndividualResult.Tag.SUCCESS
.FileMemberActionIndividualResult.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.
-
-
-
Method Detail
-
tag
public FileMemberActionIndividualResult.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 thisFileMemberActionIndividualResult
.- Returns:
- the tag for this instance.
-
isSuccess
public boolean isSuccess()
Returnstrue
if this instance has the tagFileMemberActionIndividualResult.Tag.SUCCESS
,false
otherwise.- Returns:
true
if this instance is tagged asFileMemberActionIndividualResult.Tag.SUCCESS
,false
otherwise.
-
success
public static FileMemberActionIndividualResult success(AccessLevel value)
Returns an instance ofFileMemberActionIndividualResult
that has its tag set toFileMemberActionIndividualResult.Tag.SUCCESS
.Member was successfully removed from this file. If AccessLevel is given, the member still has access via a parent shared folder.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
FileMemberActionIndividualResult
with its tag set toFileMemberActionIndividualResult.Tag.SUCCESS
.
-
success
public static FileMemberActionIndividualResult success()
Returns an instance ofFileMemberActionIndividualResult
that has its tag set toFileMemberActionIndividualResult.Tag.SUCCESS
.Member was successfully removed from this file. If AccessLevel is given, the member still has access via a parent shared folder.
- Returns:
- Instance of
FileMemberActionIndividualResult
with its tag set toFileMemberActionIndividualResult.Tag.SUCCESS
.
-
getSuccessValue
public AccessLevel getSuccessValue()
Member was successfully removed from this file. If AccessLevel is given, the member still has access via a parent shared folder.This instance must be tagged as
FileMemberActionIndividualResult.Tag.SUCCESS
.- Returns:
- The
AccessLevel
value associated with this instance ifisSuccess()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisSuccess()
isfalse
.
-
isMemberError
public boolean isMemberError()
Returnstrue
if this instance has the tagFileMemberActionIndividualResult.Tag.MEMBER_ERROR
,false
otherwise.- Returns:
true
if this instance is tagged asFileMemberActionIndividualResult.Tag.MEMBER_ERROR
,false
otherwise.
-
memberError
public static FileMemberActionIndividualResult memberError(FileMemberActionError value)
Returns an instance ofFileMemberActionIndividualResult
that has its tag set toFileMemberActionIndividualResult.Tag.MEMBER_ERROR
.User was not able to perform this action.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
FileMemberActionIndividualResult
with its tag set toFileMemberActionIndividualResult.Tag.MEMBER_ERROR
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getMemberErrorValue
public FileMemberActionError getMemberErrorValue()
User was not able to perform this action.This instance must be tagged as
FileMemberActionIndividualResult.Tag.MEMBER_ERROR
.- Returns:
- The
FileMemberActionError
value associated with this instance ifisMemberError()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisMemberError()
isfalse
.
-
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
-
-