Package com.dropbox.core.v2.sharing

Class UnshareFileError

java.lang.Object

com.dropbox.core.v2.sharing.UnshareFileError

public final class UnshareFileError
extends Object

Error result for DbxUserSharingRequests.unshareFile(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 enum	UnshareFileError.Tag	Discriminating tag type for UnshareFileError.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static UnshareFileError	accessError(SharingFileAccessError value)	Returns an instance of UnshareFileError that has its tag set to UnshareFileError.Tag.ACCESS_ERROR.
boolean	equals(Object obj)
SharingFileAccessError	getAccessErrorValue()	This instance must be tagged as UnshareFileError.Tag.ACCESS_ERROR.
SharingUserError	getUserErrorValue()	This instance must be tagged as UnshareFileError.Tag.USER_ERROR.
int	hashCode()
boolean	isAccessError()	Returns true if this instance has the tag UnshareFileError.Tag.ACCESS_ERROR, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UnshareFileError.Tag.OTHER, false otherwise.
boolean	isUserError()	Returns true if this instance has the tag UnshareFileError.Tag.USER_ERROR, false otherwise.
UnshareFileError.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.
static UnshareFileError	userError(SharingUserError value)	Returns an instance of UnshareFileError that has its tag set to UnshareFileError.Tag.USER_ERROR.

Methods inherited from class java.lang.Object

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

Field Details

OTHER

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

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

Returns:

the tag for this instance.

isUserError

public boolean isUserError()

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

Returns:

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

userError

public static UnshareFileError userError(SharingUserError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getUserErrorValue

public SharingUserError getUserErrorValue()

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

Returns:

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

Throws:

IllegalStateException - If isUserError() is false.

isAccessError

public boolean isAccessError()

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

Returns:

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

accessError

public static UnshareFileError accessError(SharingFileAccessError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharingFileAccessError getAccessErrorValue()

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

Returns:

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

Throws:

IllegalStateException - If isAccessError() is false.

isOther

public boolean isOther()

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

Returns:

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