com.dropbox.core.v2.sharing

Class UnshareFolderError

java.lang.Object

com.dropbox.core.v2.sharing.UnshareFolderError

public final class UnshareFolderError
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 and Description
static class	UnshareFolderError.Tag Discriminating tag type for UnshareFolderError.

Field Summary

Fields

Modifier and Type	Field and Description
static UnshareFolderError	NO_PERMISSION The current user does not have permission to perform this action.
static UnshareFolderError	OTHER Catch-all used for unknown tag values returned by the Dropbox servers.
static UnshareFolderError	TEAM_FOLDER This action cannot be performed on a team shared folder.

Method Summary

Modifier and Type	Method and Description
static UnshareFolderError	accessError(SharedFolderAccessError value) Returns an instance of UnshareFolderError that has its tag set to UnshareFolderError.Tag.ACCESS_ERROR.
boolean	equals(Object obj)
SharedFolderAccessError	getAccessErrorValue() This instance must be tagged as UnshareFolderError.Tag.ACCESS_ERROR.
int	hashCode()
boolean	isAccessError() Returns true if this instance has the tag UnshareFolderError.Tag.ACCESS_ERROR, false otherwise.
boolean	isNoPermission() Returns true if this instance has the tag UnshareFolderError.Tag.NO_PERMISSION, false otherwise.
boolean	isOther() Returns true if this instance has the tag UnshareFolderError.Tag.OTHER, false otherwise.
boolean	isTeamFolder() Returns true if this instance has the tag UnshareFolderError.Tag.TEAM_FOLDER, false otherwise.
UnshareFolderError.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 Detail

TEAM_FOLDER

public static final UnshareFolderError TEAM_FOLDER

This action cannot be performed on a team shared folder.

NO_PERMISSION

public static final UnshareFolderError NO_PERMISSION

The current user does not have permission to perform this action.

OTHER

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

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

Returns:

the tag for this instance.

isAccessError

public boolean isAccessError()

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

Returns:

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

accessError

public static UnshareFolderError accessError(SharedFolderAccessError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharedFolderAccessError getAccessErrorValue()

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

Returns:

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

Throws:

IllegalStateException - If isAccessError() is false.

isTeamFolder

public boolean isTeamFolder()

Returns true if this instance has the tag UnshareFolderError.Tag.TEAM_FOLDER, false otherwise.

Returns:

true if this instance is tagged as UnshareFolderError.Tag.TEAM_FOLDER, false otherwise.

isNoPermission

public boolean isNoPermission()

Returns true if this instance has the tag UnshareFolderError.Tag.NO_PERMISSION, false otherwise.

Returns:

true if this instance is tagged as UnshareFolderError.Tag.NO_PERMISSION, false otherwise.

isOther

public boolean isOther()

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

Returns:

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