Package com.dropbox.core.v2.sharing

Class JobError

java.lang.Object

com.dropbox.core.v2.sharing.JobError

public final class JobError
extends Object

Error occurred while performing an asynchronous job from DbxUserSharingRequests.unshareFolder(String,boolean) or DbxUserSharingRequests.removeFolderMember(String,MemberSelector,boolean).

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
RelinquishFolderMembershipError	getRelinquishFolderMembershipErrorValue()	Error occurred while performing DbxUserSharingRequests.relinquishFolderMembership(String,boolean) action.
RemoveFolderMemberError	getRemoveFolderMemberErrorValue()	Error occurred while performing DbxUserSharingRequests.removeFolderMember(String,MemberSelector,boolean) action.
UnshareFolderError	getUnshareFolderErrorValue()	Error occurred while performing DbxUserSharingRequests.unshareFolder(String,boolean) action.
int	hashCode()
boolean	isOther()	Returns true if this instance has the tag JobError.Tag.OTHER, false otherwise.
boolean	isRelinquishFolderMembershipError()	Returns true if this instance has the tag JobError.Tag.RELINQUISH_FOLDER_MEMBERSHIP_ERROR, false otherwise.
boolean	isRemoveFolderMemberError()	Returns true if this instance has the tag JobError.Tag.REMOVE_FOLDER_MEMBER_ERROR, false otherwise.
boolean	isUnshareFolderError()	Returns true if this instance has the tag JobError.Tag.UNSHARE_FOLDER_ERROR, false otherwise.
static JobError	relinquishFolderMembershipError(RelinquishFolderMembershipError value)	Returns an instance of JobError that has its tag set to JobError.Tag.RELINQUISH_FOLDER_MEMBERSHIP_ERROR.
static JobError	removeFolderMemberError(RemoveFolderMemberError value)	Returns an instance of JobError that has its tag set to JobError.Tag.REMOVE_FOLDER_MEMBER_ERROR.
JobError.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.
static JobError	unshareFolderError(UnshareFolderError value)	Returns an instance of JobError that has its tag set to JobError.Tag.UNSHARE_FOLDER_ERROR.

Methods inherited from class java.lang.Object

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

Field Details

OTHER

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

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

Returns:

the tag for this instance.

isUnshareFolderError

public boolean isUnshareFolderError()

Returns true if this instance has the tag JobError.Tag.UNSHARE_FOLDER_ERROR, false otherwise.

Returns:

true if this instance is tagged as JobError.Tag.UNSHARE_FOLDER_ERROR, false otherwise.

unshareFolderError

public static JobError unshareFolderError(UnshareFolderError value)

Returns an instance of JobError that has its tag set to JobError.Tag.UNSHARE_FOLDER_ERROR.

Error occurred while performing DbxUserSharingRequests.unshareFolder(String,boolean) action.

Parameters:

value - value to assign to this instance.

Returns:

Instance of JobError with its tag set to JobError.Tag.UNSHARE_FOLDER_ERROR.

Throws:

IllegalArgumentException - if value is null.

getUnshareFolderErrorValue

public UnshareFolderError getUnshareFolderErrorValue()

Error occurred while performing DbxUserSharingRequests.unshareFolder(String,boolean) action.

This instance must be tagged as JobError.Tag.UNSHARE_FOLDER_ERROR.

Returns:

The UnshareFolderError value associated with this instance if isUnshareFolderError() is true.

Throws:

IllegalStateException - If isUnshareFolderError() is false.

isRemoveFolderMemberError

public boolean isRemoveFolderMemberError()

Returns true if this instance has the tag JobError.Tag.REMOVE_FOLDER_MEMBER_ERROR, false otherwise.

Returns:

true if this instance is tagged as JobError.Tag.REMOVE_FOLDER_MEMBER_ERROR, false otherwise.

removeFolderMemberError

public static JobError removeFolderMemberError(RemoveFolderMemberError value)

Returns an instance of JobError that has its tag set to JobError.Tag.REMOVE_FOLDER_MEMBER_ERROR.

Error occurred while performing DbxUserSharingRequests.removeFolderMember(String,MemberSelector,boolean) action.

Parameters:

value - value to assign to this instance.

Returns:

Instance of JobError with its tag set to JobError.Tag.REMOVE_FOLDER_MEMBER_ERROR.

Throws:

IllegalArgumentException - if value is null.

getRemoveFolderMemberErrorValue

public RemoveFolderMemberError getRemoveFolderMemberErrorValue()

Error occurred while performing DbxUserSharingRequests.removeFolderMember(String,MemberSelector,boolean) action.

This instance must be tagged as JobError.Tag.REMOVE_FOLDER_MEMBER_ERROR.

Returns:

The RemoveFolderMemberError value associated with this instance if isRemoveFolderMemberError() is true.

Throws:

IllegalStateException - If isRemoveFolderMemberError() is false.

isRelinquishFolderMembershipError

public boolean isRelinquishFolderMembershipError()

Returns true if this instance has the tag JobError.Tag.RELINQUISH_FOLDER_MEMBERSHIP_ERROR, false otherwise.

Returns:

true if this instance is tagged as JobError.Tag.RELINQUISH_FOLDER_MEMBERSHIP_ERROR, false otherwise.

relinquishFolderMembershipError

public static JobError relinquishFolderMembershipError(RelinquishFolderMembershipError value)

Returns an instance of JobError that has its tag set to JobError.Tag.RELINQUISH_FOLDER_MEMBERSHIP_ERROR.

Error occurred while performing DbxUserSharingRequests.relinquishFolderMembership(String,boolean) action.

Parameters:

value - value to assign to this instance.

Returns:

Instance of JobError with its tag set to JobError.Tag.RELINQUISH_FOLDER_MEMBERSHIP_ERROR.

Throws:

IllegalArgumentException - if value is null.

getRelinquishFolderMembershipErrorValue

public RelinquishFolderMembershipError getRelinquishFolderMembershipErrorValue()

Error occurred while performing DbxUserSharingRequests.relinquishFolderMembership(String,boolean) action.

This instance must be tagged as JobError.Tag.RELINQUISH_FOLDER_MEMBERSHIP_ERROR.

Returns:

The RelinquishFolderMembershipError value associated with this instance if isRelinquishFolderMembershipError() is true.

Throws:

IllegalStateException - If isRelinquishFolderMembershipError() is false.

isOther

public boolean isOther()

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

Returns:

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