com.dropbox.core.v2.files

Class DeleteError

java.lang.Object

com.dropbox.core.v2.files.DeleteError

public final class DeleteError
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 and Description
static class	DeleteError.Tag Discriminating tag type for DeleteError.

Field Summary

Fields

Modifier and Type	Field and Description
static DeleteError	OTHER Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
LookupError	getPathLookupValue() This instance must be tagged as DeleteError.Tag.PATH_LOOKUP.
WriteError	getPathWriteValue() This instance must be tagged as DeleteError.Tag.PATH_WRITE.
int	hashCode()
boolean	isOther() Returns true if this instance has the tag DeleteError.Tag.OTHER, false otherwise.
boolean	isPathLookup() Returns true if this instance has the tag DeleteError.Tag.PATH_LOOKUP, false otherwise.
boolean	isPathWrite() Returns true if this instance has the tag DeleteError.Tag.PATH_WRITE, false otherwise.
static DeleteError	pathLookup(LookupError value) Returns an instance of DeleteError that has its tag set to DeleteError.Tag.PATH_LOOKUP.
static DeleteError	pathWrite(WriteError value) Returns an instance of DeleteError that has its tag set to DeleteError.Tag.PATH_WRITE.
DeleteError.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 Detail

OTHER

public static final DeleteError 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 Detail

tag

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

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

Returns:

the tag for this instance.

isPathLookup

public boolean isPathLookup()

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

Returns:

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

pathLookup

public static DeleteError pathLookup(LookupError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getPathLookupValue

public LookupError getPathLookupValue()

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

Returns:

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

pathWrite

public static DeleteError pathWrite(WriteError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getPathWriteValue

public WriteError getPathWriteValue()

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

Returns:

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

Throws:

IllegalStateException - If isPathWrite() is false.

isOther

public boolean isOther()

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

Returns:

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