Package com.dropbox.core.v2.sharing

Class ListFileMembersError

java.lang.Object

com.dropbox.core.v2.sharing.ListFileMembersError

public final class ListFileMembersError
extends java.lang.Object

Error for DbxUserSharingRequests.listFileMembers(String).

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 class	ListFileMembersError.Tag	Discriminating tag type for ListFileMembersError.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ListFileMembersError	accessError(SharingFileAccessError value)	Returns an instance of ListFileMembersError that has its tag set to ListFileMembersError.Tag.ACCESS_ERROR.
boolean	equals(java.lang.Object obj)
SharingFileAccessError	getAccessErrorValue()	This instance must be tagged as ListFileMembersError.Tag.ACCESS_ERROR.
SharingUserError	getUserErrorValue()	This instance must be tagged as ListFileMembersError.Tag.USER_ERROR.
int	hashCode()
boolean	isAccessError()	Returns true if this instance has the tag ListFileMembersError.Tag.ACCESS_ERROR, false otherwise.
boolean	isOther()	Returns true if this instance has the tag ListFileMembersError.Tag.OTHER, false otherwise.
boolean	isUserError()	Returns true if this instance has the tag ListFileMembersError.Tag.USER_ERROR, false otherwise.
ListFileMembersError.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.
static ListFileMembersError	userError(SharingUserError value)	Returns an instance of ListFileMembersError that has its tag set to ListFileMembersError.Tag.USER_ERROR.

Methods inherited from class java.lang.Object

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

Field Detail

OTHER

public static final ListFileMembersError 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 ListFileMembersError.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 ListFileMembersError.

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

Returns:

the tag for this instance.

isUserError

public boolean isUserError()

Returns true if this instance has the tag ListFileMembersError.Tag.USER_ERROR, false otherwise.

Returns:

true if this instance is tagged as ListFileMembersError.Tag.USER_ERROR, false otherwise.

userError

public static ListFileMembersError userError(SharingUserError value)

Returns an instance of ListFileMembersError that has its tag set to ListFileMembersError.Tag.USER_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of ListFileMembersError with its tag set to ListFileMembersError.Tag.USER_ERROR.

Throws:

java.lang.IllegalArgumentException - if value is null.

getUserErrorValue

public SharingUserError getUserErrorValue()

This instance must be tagged as ListFileMembersError.Tag.USER_ERROR.

Returns:

The SharingUserError value associated with this instance if isUserError() is true.

Throws:

java.lang.IllegalStateException - If isUserError() is false.

isAccessError

public boolean isAccessError()

Returns true if this instance has the tag ListFileMembersError.Tag.ACCESS_ERROR, false otherwise.

Returns:

true if this instance is tagged as ListFileMembersError.Tag.ACCESS_ERROR, false otherwise.

accessError

public static ListFileMembersError accessError(SharingFileAccessError value)

Returns an instance of ListFileMembersError that has its tag set to ListFileMembersError.Tag.ACCESS_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of ListFileMembersError with its tag set to ListFileMembersError.Tag.ACCESS_ERROR.

Throws:

java.lang.IllegalArgumentException - if value is null.

getAccessErrorValue

public SharingFileAccessError getAccessErrorValue()

This instance must be tagged as ListFileMembersError.Tag.ACCESS_ERROR.

Returns:

The SharingFileAccessError value associated with this instance if isAccessError() is true.

Throws:

java.lang.IllegalStateException - If isAccessError() is false.

isOther

public boolean isOther()

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

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.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