Package com.dropbox.core.v2.files

Class LookupError

java.lang.Object

com.dropbox.core.v2.files.LookupError

public final class LookupError
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 class	LookupError.Serializer	For internal use only.
static enum	LookupError.Tag	Discriminating tag type for LookupError.

Field Summary

Fields

Modifier and Type	Field	Description
static final LookupError	LOCKED	The given path is locked.
static final LookupError	NOT_FILE	We were expecting a file, but the given path refers to something that isn't a file.
static final LookupError	NOT_FOLDER	We were expecting a folder, but the given path refers to something that isn't a folder.
static final LookupError	NOT_FOUND	There is nothing at the given path.
static final LookupError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final LookupError	RESTRICTED_CONTENT	The file cannot be transferred because the content is restricted.
static final LookupError	UNSUPPORTED_CONTENT_TYPE	This operation is not supported for this content type.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getMalformedPathValue()	The given path does not satisfy the required path format.
int	hashCode()
boolean	isLocked()	Returns true if this instance has the tag LookupError.Tag.LOCKED, false otherwise.
boolean	isMalformedPath()	Returns true if this instance has the tag LookupError.Tag.MALFORMED_PATH, false otherwise.
boolean	isNotFile()	Returns true if this instance has the tag LookupError.Tag.NOT_FILE, false otherwise.
boolean	isNotFolder()	Returns true if this instance has the tag LookupError.Tag.NOT_FOLDER, false otherwise.
boolean	isNotFound()	Returns true if this instance has the tag LookupError.Tag.NOT_FOUND, false otherwise.
boolean	isOther()	Returns true if this instance has the tag LookupError.Tag.OTHER, false otherwise.
boolean	isRestrictedContent()	Returns true if this instance has the tag LookupError.Tag.RESTRICTED_CONTENT, false otherwise.
boolean	isUnsupportedContentType()	Returns true if this instance has the tag LookupError.Tag.UNSUPPORTED_CONTENT_TYPE, false otherwise.
static LookupError	malformedPath()	Returns an instance of LookupError that has its tag set to LookupError.Tag.MALFORMED_PATH.
static LookupError	malformedPath(String value)	Returns an instance of LookupError that has its tag set to LookupError.Tag.MALFORMED_PATH.
LookupError.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

NOT_FOUND

public static final LookupError NOT_FOUND

There is nothing at the given path.

NOT_FILE

public static final LookupError NOT_FILE

We were expecting a file, but the given path refers to something that isn't a file.

NOT_FOLDER

public static final LookupError NOT_FOLDER

We were expecting a folder, but the given path refers to something that isn't a folder.

RESTRICTED_CONTENT

public static final LookupError RESTRICTED_CONTENT

The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements.

UNSUPPORTED_CONTENT_TYPE

public static final LookupError UNSUPPORTED_CONTENT_TYPE

This operation is not supported for this content type.

LOCKED

public static final LookupError LOCKED

The given path is locked.

OTHER

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

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

Returns:

the tag for this instance.

isMalformedPath

public boolean isMalformedPath()

Returns true if this instance has the tag LookupError.Tag.MALFORMED_PATH, false otherwise.

Returns:

true if this instance is tagged as LookupError.Tag.MALFORMED_PATH, false otherwise.

malformedPath

public static LookupError malformedPath(String value)

Returns an instance of LookupError that has its tag set to LookupError.Tag.MALFORMED_PATH.

The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.

Parameters:

value - value to assign to this instance.

Returns:

Instance of LookupError with its tag set to LookupError.Tag.MALFORMED_PATH.

malformedPath

public static LookupError malformedPath()

Returns an instance of LookupError that has its tag set to LookupError.Tag.MALFORMED_PATH.

The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.

Returns:

Instance of LookupError with its tag set to LookupError.Tag.MALFORMED_PATH.

getMalformedPathValue

public String getMalformedPathValue()

The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.

This instance must be tagged as LookupError.Tag.MALFORMED_PATH.

Returns:

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

Throws:

IllegalStateException - If isMalformedPath() is false.

isNotFound

public boolean isNotFound()

Returns true if this instance has the tag LookupError.Tag.NOT_FOUND, false otherwise.

Returns:

true if this instance is tagged as LookupError.Tag.NOT_FOUND, false otherwise.

isNotFile

public boolean isNotFile()

Returns true if this instance has the tag LookupError.Tag.NOT_FILE, false otherwise.

Returns:

true if this instance is tagged as LookupError.Tag.NOT_FILE, false otherwise.

isNotFolder

public boolean isNotFolder()

Returns true if this instance has the tag LookupError.Tag.NOT_FOLDER, false otherwise.

Returns:

true if this instance is tagged as LookupError.Tag.NOT_FOLDER, false otherwise.

isRestrictedContent

public boolean isRestrictedContent()

Returns true if this instance has the tag LookupError.Tag.RESTRICTED_CONTENT, false otherwise.

Returns:

true if this instance is tagged as LookupError.Tag.RESTRICTED_CONTENT, false otherwise.

isUnsupportedContentType

public boolean isUnsupportedContentType()

Returns true if this instance has the tag LookupError.Tag.UNSUPPORTED_CONTENT_TYPE, false otherwise.

Returns:

true if this instance is tagged as LookupError.Tag.UNSUPPORTED_CONTENT_TYPE, false otherwise.

isLocked

public boolean isLocked()

Returns true if this instance has the tag LookupError.Tag.LOCKED, false otherwise.

Returns:

true if this instance is tagged as LookupError.Tag.LOCKED, false otherwise.

isOther

public boolean isOther()

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

Returns:

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