Package com.dropbox.core.v2.files

Class ThumbnailError

java.lang.Object

com.dropbox.core.v2.files.ThumbnailError

public final class ThumbnailError
extends Object

This class is a 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ThumbnailError.Tag	Discriminating tag type for ThumbnailError.

Field Summary

Fields

Modifier and Type	Field	Description
static final ThumbnailError	CONVERSION_ERROR	An error occurs during thumbnail conversion.
static final ThumbnailError	ENCRYPTED_CONTENT	Encrypted content cannot be converted to a thumbnail.
static final ThumbnailError	UNSUPPORTED_EXTENSION	The file extension doesn't allow conversion to a thumbnail.
static final ThumbnailError	UNSUPPORTED_IMAGE	The image cannot be converted to a thumbnail.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
LookupError	getPathValue()	An error occurs when downloading metadata for the image.
int	hashCode()
boolean	isConversionError()	Returns true if this instance has the tag ThumbnailError.Tag.CONVERSION_ERROR, false otherwise.
boolean	isEncryptedContent()	Returns true if this instance has the tag ThumbnailError.Tag.ENCRYPTED_CONTENT, false otherwise.
boolean	isPath()	Returns true if this instance has the tag ThumbnailError.Tag.PATH, false otherwise.
boolean	isUnsupportedExtension()	Returns true if this instance has the tag ThumbnailError.Tag.UNSUPPORTED_EXTENSION, false otherwise.
boolean	isUnsupportedImage()	Returns true if this instance has the tag ThumbnailError.Tag.UNSUPPORTED_IMAGE, false otherwise.
static ThumbnailError	path(LookupError value)	Returns an instance of ThumbnailError that has its tag set to ThumbnailError.Tag.PATH.
ThumbnailError.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 Details

UNSUPPORTED_EXTENSION

public static final ThumbnailError UNSUPPORTED_EXTENSION

The file extension doesn't allow conversion to a thumbnail.

UNSUPPORTED_IMAGE

public static final ThumbnailError UNSUPPORTED_IMAGE

The image cannot be converted to a thumbnail.

ENCRYPTED_CONTENT

public static final ThumbnailError ENCRYPTED_CONTENT

Encrypted content cannot be converted to a thumbnail.

CONVERSION_ERROR

public static final ThumbnailError CONVERSION_ERROR

An error occurs during thumbnail conversion.

Method Details

tag

public ThumbnailError.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 ThumbnailError.

Returns:

the tag for this instance.

isPath

public boolean isPath()

Returns true if this instance has the tag ThumbnailError.Tag.PATH, false otherwise.

Returns:

true if this instance is tagged as ThumbnailError.Tag.PATH, false otherwise.

path

public static ThumbnailError path(LookupError value)

Returns an instance of ThumbnailError that has its tag set to ThumbnailError.Tag.PATH.

An error occurs when downloading metadata for the image.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ThumbnailError with its tag set to ThumbnailError.Tag.PATH.

Throws:

IllegalArgumentException - if value is null.

getPathValue

public LookupError getPathValue()

An error occurs when downloading metadata for the image.

This instance must be tagged as ThumbnailError.Tag.PATH.

Returns:

The LookupError value associated with this instance if isPath() is true.

Throws:

IllegalStateException - If isPath() is false.

isUnsupportedExtension

public boolean isUnsupportedExtension()

Returns true if this instance has the tag ThumbnailError.Tag.UNSUPPORTED_EXTENSION, false otherwise.

Returns:

true if this instance is tagged as ThumbnailError.Tag.UNSUPPORTED_EXTENSION, false otherwise.

isUnsupportedImage

public boolean isUnsupportedImage()

Returns true if this instance has the tag ThumbnailError.Tag.UNSUPPORTED_IMAGE, false otherwise.

Returns:

true if this instance is tagged as ThumbnailError.Tag.UNSUPPORTED_IMAGE, false otherwise.

isEncryptedContent

public boolean isEncryptedContent()

Returns true if this instance has the tag ThumbnailError.Tag.ENCRYPTED_CONTENT, false otherwise.

Returns:

true if this instance is tagged as ThumbnailError.Tag.ENCRYPTED_CONTENT, false otherwise.

isConversionError

public boolean isConversionError()

Returns true if this instance has the tag ThumbnailError.Tag.CONVERSION_ERROR, false otherwise.

Returns:

true if this instance is tagged as ThumbnailError.Tag.CONVERSION_ERROR, 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