Package com.dropbox.core.v2.files

Class RestoreError

java.lang.Object

com.dropbox.core.v2.files.RestoreError

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

Field Summary

Fields

Modifier and Type	Field	Description
static final RestoreError	IN_PROGRESS	The restore is currently executing, but has not yet completed.
static final RestoreError	INVALID_REVISION	The revision is invalid.
static final RestoreError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
LookupError	getPathLookupValue()	An error occurs when downloading metadata for the file.
WriteError	getPathWriteValue()	An error occurs when trying to restore the file to that path.
int	hashCode()
boolean	isInProgress()	Returns true if this instance has the tag RestoreError.Tag.IN_PROGRESS, false otherwise.
boolean	isInvalidRevision()	Returns true if this instance has the tag RestoreError.Tag.INVALID_REVISION, false otherwise.
boolean	isOther()	Returns true if this instance has the tag RestoreError.Tag.OTHER, false otherwise.
boolean	isPathLookup()	Returns true if this instance has the tag RestoreError.Tag.PATH_LOOKUP, false otherwise.
boolean	isPathWrite()	Returns true if this instance has the tag RestoreError.Tag.PATH_WRITE, false otherwise.
static RestoreError	pathLookup(LookupError value)	Returns an instance of RestoreError that has its tag set to RestoreError.Tag.PATH_LOOKUP.
static RestoreError	pathWrite(WriteError value)	Returns an instance of RestoreError that has its tag set to RestoreError.Tag.PATH_WRITE.
RestoreError.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

INVALID_REVISION

public static final RestoreError INVALID_REVISION

The revision is invalid. It may not exist or may point to a deleted file.

IN_PROGRESS

public static final RestoreError IN_PROGRESS

The restore is currently executing, but has not yet completed.

OTHER

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

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

Returns:

the tag for this instance.

isPathLookup

public boolean isPathLookup()

Returns true if this instance has the tag RestoreError.Tag.PATH_LOOKUP, false otherwise.

Returns:

true if this instance is tagged as RestoreError.Tag.PATH_LOOKUP, false otherwise.

pathLookup

public static RestoreError pathLookup(LookupError value)

Returns an instance of RestoreError that has its tag set to RestoreError.Tag.PATH_LOOKUP.

An error occurs when downloading metadata for the file.

Parameters:

value - value to assign to this instance.

Returns:

Instance of RestoreError with its tag set to RestoreError.Tag.PATH_LOOKUP.

Throws:

IllegalArgumentException - if value is null.

getPathLookupValue

public LookupError getPathLookupValue()

An error occurs when downloading metadata for the file.

This instance must be tagged as RestoreError.Tag.PATH_LOOKUP.

Returns:

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

Throws:

IllegalStateException - If isPathLookup() is false.

isPathWrite

public boolean isPathWrite()

Returns true if this instance has the tag RestoreError.Tag.PATH_WRITE, false otherwise.

Returns:

true if this instance is tagged as RestoreError.Tag.PATH_WRITE, false otherwise.

pathWrite

public static RestoreError pathWrite(WriteError value)

Returns an instance of RestoreError that has its tag set to RestoreError.Tag.PATH_WRITE.

An error occurs when trying to restore the file to that path.

Parameters:

value - value to assign to this instance.

Returns:

Instance of RestoreError with its tag set to RestoreError.Tag.PATH_WRITE.

Throws:

IllegalArgumentException - if value is null.

getPathWriteValue

public WriteError getPathWriteValue()

An error occurs when trying to restore the file to that path.

This instance must be tagged as RestoreError.Tag.PATH_WRITE.

Returns:

The WriteError value associated with this instance if isPathWrite() is true.

Throws:

IllegalStateException - If isPathWrite() is false.

isInvalidRevision

public boolean isInvalidRevision()

Returns true if this instance has the tag RestoreError.Tag.INVALID_REVISION, false otherwise.

Returns:

true if this instance is tagged as RestoreError.Tag.INVALID_REVISION, false otherwise.

isInProgress

public boolean isInProgress()

Returns true if this instance has the tag RestoreError.Tag.IN_PROGRESS, false otherwise.

Returns:

true if this instance is tagged as RestoreError.Tag.IN_PROGRESS, false otherwise.

isOther

public boolean isOther()

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

Returns:

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