Package com.dropbox.core.v2.riviera

Class MarkdownConversionApiV2Error

java.lang.Object

com.dropbox.core.v2.riviera.MarkdownConversionApiV2Error

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

Field Summary

Fields

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

UNSUPPORTED_FORMAT_ERROR

public static final MarkdownConversionApiV2Error UNSUPPORTED_FORMAT_ERROR

LINK_DOWNLOAD_DISABLED_ERROR

public static final MarkdownConversionApiV2Error LINK_DOWNLOAD_DISABLED_ERROR

SHARED_LINK_PASSWORD_PROTECTED

public static final MarkdownConversionApiV2Error SHARED_LINK_PASSWORD_PROTECTED

LIMIT_EXCEEDED_ERROR

public static final MarkdownConversionApiV2Error LIMIT_EXCEEDED_ERROR

CONVERSION_FAILURE_ERROR

public static final MarkdownConversionApiV2Error CONVERSION_FAILURE_ERROR

OTHER

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

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

Returns:

the tag for this instance.

isServerError

public boolean isServerError()

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

Returns:

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

serverError

public static MarkdownConversionApiV2Error serverError(String value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getServerErrorValue

public String getServerErrorValue()

This instance must be tagged as MarkdownConversionApiV2Error.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 MarkdownConversionApiV2Error.Tag.USER_ERROR, false otherwise.

Returns:

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

userError

public static MarkdownConversionApiV2Error userError(String value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getUserErrorValue

public String getUserErrorValue()

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

Returns:

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

Throws:

IllegalStateException - If isUserError() is false.

isUnsupportedFormatError

public boolean isUnsupportedFormatError()

Returns true if this instance has the tag MarkdownConversionApiV2Error.Tag.UNSUPPORTED_FORMAT_ERROR, false otherwise.

Returns:

true if this instance is tagged as MarkdownConversionApiV2Error.Tag.UNSUPPORTED_FORMAT_ERROR, false otherwise.

isLinkDownloadDisabledError

public boolean isLinkDownloadDisabledError()

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

Returns:

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

isSharedLinkPasswordProtected

public boolean isSharedLinkPasswordProtected()

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

Returns:

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

isLimitExceededError

public boolean isLimitExceededError()

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

Returns:

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

isConversionFailureError

public boolean isConversionFailureError()

Returns true if this instance has the tag MarkdownConversionApiV2Error.Tag.CONVERSION_FAILURE_ERROR, false otherwise.

Returns:

true if this instance is tagged as MarkdownConversionApiV2Error.Tag.CONVERSION_FAILURE_ERROR, false otherwise.

isOther

public boolean isOther()

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

Returns:

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