Package com.dropbox.core.v2.sharing

Class FileMemberRemoveActionResult

java.lang.Object

com.dropbox.core.v2.sharing.FileMemberRemoveActionResult

public final class FileMemberRemoveActionResult
extends Object

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() 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 enum	FileMemberRemoveActionResult.Tag	Discriminating tag type for FileMemberRemoveActionResult.

Field Summary

Fields

Modifier and Type	Field	Description
static final FileMemberRemoveActionResult	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
FileMemberActionError	getMemberErrorValue()	User was not able to remove this member.
MemberAccessLevelResult	getSuccessValue()	Member was successfully removed from this file.
int	hashCode()
boolean	isMemberError()	Returns true if this instance has the tag FileMemberRemoveActionResult.Tag.MEMBER_ERROR, false otherwise.
boolean	isOther()	Returns true if this instance has the tag FileMemberRemoveActionResult.Tag.OTHER, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag FileMemberRemoveActionResult.Tag.SUCCESS, false otherwise.
static FileMemberRemoveActionResult	memberError(FileMemberActionError value)	Returns an instance of FileMemberRemoveActionResult that has its tag set to FileMemberRemoveActionResult.Tag.MEMBER_ERROR.
static FileMemberRemoveActionResult	success(MemberAccessLevelResult value)	Returns an instance of FileMemberRemoveActionResult that has its tag set to FileMemberRemoveActionResult.Tag.SUCCESS.
FileMemberRemoveActionResult.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

OTHER

public static final FileMemberRemoveActionResult 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 Details

tag

public FileMemberRemoveActionResult.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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this FileMemberRemoveActionResult.

If a tag returned by the server is unrecognized by this SDK, the FileMemberRemoveActionResult.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

Returns true if this instance has the tag FileMemberRemoveActionResult.Tag.SUCCESS, false otherwise.

Returns:

true if this instance is tagged as FileMemberRemoveActionResult.Tag.SUCCESS, false otherwise.

success

public static FileMemberRemoveActionResult success(MemberAccessLevelResult value)

Returns an instance of FileMemberRemoveActionResult that has its tag set to FileMemberRemoveActionResult.Tag.SUCCESS.

Member was successfully removed from this file.

Parameters:

value - value to assign to this instance.

Returns:

Instance of FileMemberRemoveActionResult with its tag set to FileMemberRemoveActionResult.Tag.SUCCESS.

Throws:

IllegalArgumentException - if value is null.

getSuccessValue

public MemberAccessLevelResult getSuccessValue()

Member was successfully removed from this file.

This instance must be tagged as FileMemberRemoveActionResult.Tag.SUCCESS.

Returns:

The MemberAccessLevelResult value associated with this instance if isSuccess() is true.

Throws:

IllegalStateException - If isSuccess() is false.

isMemberError

public boolean isMemberError()

Returns true if this instance has the tag FileMemberRemoveActionResult.Tag.MEMBER_ERROR, false otherwise.

Returns:

true if this instance is tagged as FileMemberRemoveActionResult.Tag.MEMBER_ERROR, false otherwise.

memberError

public static FileMemberRemoveActionResult memberError(FileMemberActionError value)

Returns an instance of FileMemberRemoveActionResult that has its tag set to FileMemberRemoveActionResult.Tag.MEMBER_ERROR.

User was not able to remove this member.

Parameters:

value - value to assign to this instance.

Returns:

Instance of FileMemberRemoveActionResult with its tag set to FileMemberRemoveActionResult.Tag.MEMBER_ERROR.

Throws:

IllegalArgumentException - if value is null.

getMemberErrorValue

public FileMemberActionError getMemberErrorValue()

User was not able to remove this member.

This instance must be tagged as FileMemberRemoveActionResult.Tag.MEMBER_ERROR.

Returns:

The FileMemberActionError value associated with this instance if isMemberError() is true.

Throws:

IllegalStateException - If isMemberError() is false.

isOther

public boolean isOther()

Returns true if this instance has the tag FileMemberRemoveActionResult.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as FileMemberRemoveActionResult.Tag.OTHER, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public 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