Package com.dropbox.core.v2.riviera

Class ContentApiV2Error

java.lang.Object

com.dropbox.core.v2.riviera.ContentApiV2Error

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ContentApiV2Error	LIMIT_EXCEEDED_ERROR
static final ContentApiV2Error	LINK_DOWNLOAD_DISABLED_ERROR
static final ContentApiV2Error	NO_AUDIO_ERROR
static final ContentApiV2Error	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final ContentApiV2Error	SHARED_LINK_PASSWORD_PROTECTED

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
MediaDurationError	getMediaDurationErrorValue()	This instance must be tagged as ContentApiV2Error.Tag.MEDIA_DURATION_ERROR.
String	getServerErrorValue()	This instance must be tagged as ContentApiV2Error.Tag.SERVER_ERROR.
String	getUserErrorValue()	This instance must be tagged as ContentApiV2Error.Tag.USER_ERROR.
int	hashCode()
boolean	isLimitExceededError()	Returns true if this instance has the tag ContentApiV2Error.Tag.LIMIT_EXCEEDED_ERROR, false otherwise.
boolean	isLinkDownloadDisabledError()	Returns true if this instance has the tag ContentApiV2Error.Tag.LINK_DOWNLOAD_DISABLED_ERROR, false otherwise.
boolean	isMediaDurationError()	Returns true if this instance has the tag ContentApiV2Error.Tag.MEDIA_DURATION_ERROR, false otherwise.
boolean	isNoAudioError()	Returns true if this instance has the tag ContentApiV2Error.Tag.NO_AUDIO_ERROR, false otherwise.
boolean	isOther()	Returns true if this instance has the tag ContentApiV2Error.Tag.OTHER, false otherwise.
boolean	isServerError()	Returns true if this instance has the tag ContentApiV2Error.Tag.SERVER_ERROR, false otherwise.
boolean	isSharedLinkPasswordProtected()	Returns true if this instance has the tag ContentApiV2Error.Tag.SHARED_LINK_PASSWORD_PROTECTED, false otherwise.
boolean	isUserError()	Returns true if this instance has the tag ContentApiV2Error.Tag.USER_ERROR, false otherwise.
static ContentApiV2Error	mediaDurationError(MediaDurationError value)	Returns an instance of ContentApiV2Error that has its tag set to ContentApiV2Error.Tag.MEDIA_DURATION_ERROR.
static ContentApiV2Error	serverError(String value)	Returns an instance of ContentApiV2Error that has its tag set to ContentApiV2Error.Tag.SERVER_ERROR.
ContentApiV2Error.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.
static ContentApiV2Error	userError(String value)	Returns an instance of ContentApiV2Error that has its tag set to ContentApiV2Error.Tag.USER_ERROR.

Methods inherited from class java.lang.Object

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

Field Details

NO_AUDIO_ERROR

public static final ContentApiV2Error NO_AUDIO_ERROR

LINK_DOWNLOAD_DISABLED_ERROR

public static final ContentApiV2Error LINK_DOWNLOAD_DISABLED_ERROR

SHARED_LINK_PASSWORD_PROTECTED

public static final ContentApiV2Error SHARED_LINK_PASSWORD_PROTECTED

LIMIT_EXCEEDED_ERROR

public static final ContentApiV2Error LIMIT_EXCEEDED_ERROR

OTHER

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

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

Returns:

the tag for this instance.

isServerError

public boolean isServerError()

Returns true if this instance has the tag ContentApiV2Error.Tag.SERVER_ERROR, false otherwise.

Returns:

true if this instance is tagged as ContentApiV2Error.Tag.SERVER_ERROR, false otherwise.

serverError

public static ContentApiV2Error serverError(String value)

Returns an instance of ContentApiV2Error that has its tag set to ContentApiV2Error.Tag.SERVER_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of ContentApiV2Error with its tag set to ContentApiV2Error.Tag.SERVER_ERROR.

Throws:

IllegalArgumentException - if value is null.

getServerErrorValue

public String getServerErrorValue()

This instance must be tagged as ContentApiV2Error.Tag.SERVER_ERROR.

Returns:

The String value associated with this instance if isServerError() is true.

Throws:

IllegalStateException - If isServerError() is false.

isUserError

public boolean isUserError()

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

Returns:

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

userError

public static ContentApiV2Error userError(String value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getUserErrorValue

public String getUserErrorValue()

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

Returns:

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

Throws:

IllegalStateException - If isUserError() is false.

isMediaDurationError

public boolean isMediaDurationError()

Returns true if this instance has the tag ContentApiV2Error.Tag.MEDIA_DURATION_ERROR, false otherwise.

Returns:

true if this instance is tagged as ContentApiV2Error.Tag.MEDIA_DURATION_ERROR, false otherwise.

mediaDurationError

public static ContentApiV2Error mediaDurationError(MediaDurationError value)

Returns an instance of ContentApiV2Error that has its tag set to ContentApiV2Error.Tag.MEDIA_DURATION_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of ContentApiV2Error with its tag set to ContentApiV2Error.Tag.MEDIA_DURATION_ERROR.

Throws:

IllegalArgumentException - if value is null.

getMediaDurationErrorValue

public MediaDurationError getMediaDurationErrorValue()

This instance must be tagged as ContentApiV2Error.Tag.MEDIA_DURATION_ERROR.

Returns:

The MediaDurationError value associated with this instance if isMediaDurationError() is true.

Throws:

IllegalStateException - If isMediaDurationError() is false.

isNoAudioError

public boolean isNoAudioError()

Returns true if this instance has the tag ContentApiV2Error.Tag.NO_AUDIO_ERROR, false otherwise.

Returns:

true if this instance is tagged as ContentApiV2Error.Tag.NO_AUDIO_ERROR, false otherwise.

isLinkDownloadDisabledError

public boolean isLinkDownloadDisabledError()

Returns true if this instance has the tag ContentApiV2Error.Tag.LINK_DOWNLOAD_DISABLED_ERROR, false otherwise.

Returns:

true if this instance is tagged as ContentApiV2Error.Tag.LINK_DOWNLOAD_DISABLED_ERROR, false otherwise.

isSharedLinkPasswordProtected

public boolean isSharedLinkPasswordProtected()

Returns true if this instance has the tag ContentApiV2Error.Tag.SHARED_LINK_PASSWORD_PROTECTED, false otherwise.

Returns:

true if this instance is tagged as ContentApiV2Error.Tag.SHARED_LINK_PASSWORD_PROTECTED, false otherwise.

isLimitExceededError

public boolean isLimitExceededError()

Returns true if this instance has the tag ContentApiV2Error.Tag.LIMIT_EXCEEDED_ERROR, false otherwise.

Returns:

true if this instance is tagged as ContentApiV2Error.Tag.LIMIT_EXCEEDED_ERROR, false otherwise.

isOther

public boolean isOther()

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

Returns:

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