Package com.dropbox.core.v2.sharing

Class SharedFolderMemberError

java.lang.Object

com.dropbox.core.v2.sharing.SharedFolderMemberError

public final class SharedFolderMemberError
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	SharedFolderMemberError.Tag	Discriminating tag type for SharedFolderMemberError.

Field Summary

Fields

Modifier and Type	Field	Description
static final SharedFolderMemberError	INVALID_DROPBOX_ID	The target dropbox_id is invalid.
static final SharedFolderMemberError	NOT_A_MEMBER	The target dropbox_id is not a member of the shared folder.
static final SharedFolderMemberError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
MemberAccessLevelResult	getNoExplicitAccessValue()	The target member only has inherited access to the shared folder.
int	hashCode()
boolean	isInvalidDropboxId()	Returns true if this instance has the tag SharedFolderMemberError.Tag.INVALID_DROPBOX_ID, false otherwise.
boolean	isNoExplicitAccess()	Returns true if this instance has the tag SharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS, false otherwise.
boolean	isNotAMember()	Returns true if this instance has the tag SharedFolderMemberError.Tag.NOT_A_MEMBER, false otherwise.
boolean	isOther()	Returns true if this instance has the tag SharedFolderMemberError.Tag.OTHER, false otherwise.
static SharedFolderMemberError	noExplicitAccess(MemberAccessLevelResult value)	Returns an instance of SharedFolderMemberError that has its tag set to SharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS.
SharedFolderMemberError.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

INVALID_DROPBOX_ID

public static final SharedFolderMemberError INVALID_DROPBOX_ID

The target dropbox_id is invalid.

NOT_A_MEMBER

public static final SharedFolderMemberError NOT_A_MEMBER

The target dropbox_id is not a member of the shared folder.

OTHER

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

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

Returns:

the tag for this instance.

isInvalidDropboxId

public boolean isInvalidDropboxId()

Returns true if this instance has the tag SharedFolderMemberError.Tag.INVALID_DROPBOX_ID, false otherwise.

Returns:

true if this instance is tagged as SharedFolderMemberError.Tag.INVALID_DROPBOX_ID, false otherwise.

isNotAMember

public boolean isNotAMember()

Returns true if this instance has the tag SharedFolderMemberError.Tag.NOT_A_MEMBER, false otherwise.

Returns:

true if this instance is tagged as SharedFolderMemberError.Tag.NOT_A_MEMBER, false otherwise.

isNoExplicitAccess

public boolean isNoExplicitAccess()

Returns true if this instance has the tag SharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS, false otherwise.

Returns:

true if this instance is tagged as SharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS, false otherwise.

noExplicitAccess

public static SharedFolderMemberError noExplicitAccess(MemberAccessLevelResult value)

Returns an instance of SharedFolderMemberError that has its tag set to SharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS.

The target member only has inherited access to the shared folder.

Parameters:

value - value to assign to this instance.

Returns:

Instance of SharedFolderMemberError with its tag set to SharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS.

Throws:

IllegalArgumentException - if value is null.

getNoExplicitAccessValue

public MemberAccessLevelResult getNoExplicitAccessValue()

The target member only has inherited access to the shared folder.

This instance must be tagged as SharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS.

Returns:

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

Throws:

IllegalStateException - If isNoExplicitAccess() is false.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as SharedFolderMemberError.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