Package com.dropbox.core.v2.files

Class RelocationBatchResultEntry

java.lang.Object

com.dropbox.core.v2.files.RelocationBatchResultEntry

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static RelocationBatchResultEntry	failure(RelocationBatchErrorEntry value)	Returns an instance of RelocationBatchResultEntry that has its tag set to RelocationBatchResultEntry.Tag.FAILURE.
RelocationBatchErrorEntry	getFailureValue()	This instance must be tagged as RelocationBatchResultEntry.Tag.FAILURE.
Metadata	getSuccessValue()	This instance must be tagged as RelocationBatchResultEntry.Tag.SUCCESS.
int	hashCode()
boolean	isFailure()	Returns true if this instance has the tag RelocationBatchResultEntry.Tag.FAILURE, false otherwise.
boolean	isOther()	Returns true if this instance has the tag RelocationBatchResultEntry.Tag.OTHER, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag RelocationBatchResultEntry.Tag.SUCCESS, false otherwise.
static RelocationBatchResultEntry	success(Metadata value)	Returns an instance of RelocationBatchResultEntry that has its tag set to RelocationBatchResultEntry.Tag.SUCCESS.
RelocationBatchResultEntry.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

OTHER

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

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

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

Returns true if this instance has the tag RelocationBatchResultEntry.Tag.SUCCESS, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchResultEntry.Tag.SUCCESS, false otherwise.

success

public static RelocationBatchResultEntry success(Metadata value)

Returns an instance of RelocationBatchResultEntry that has its tag set to RelocationBatchResultEntry.Tag.SUCCESS.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchResultEntry with its tag set to RelocationBatchResultEntry.Tag.SUCCESS.

Throws:

IllegalArgumentException - if value is null.

getSuccessValue

public Metadata getSuccessValue()

This instance must be tagged as RelocationBatchResultEntry.Tag.SUCCESS.

Returns:

The Metadata value associated with this instance if isSuccess() is true.

Throws:

IllegalStateException - If isSuccess() is false.

isFailure

public boolean isFailure()

Returns true if this instance has the tag RelocationBatchResultEntry.Tag.FAILURE, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchResultEntry.Tag.FAILURE, false otherwise.

failure

public static RelocationBatchResultEntry failure(RelocationBatchErrorEntry value)

Returns an instance of RelocationBatchResultEntry that has its tag set to RelocationBatchResultEntry.Tag.FAILURE.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchResultEntry with its tag set to RelocationBatchResultEntry.Tag.FAILURE.

Throws:

IllegalArgumentException - if value is null.

getFailureValue

public RelocationBatchErrorEntry getFailureValue()

This instance must be tagged as RelocationBatchResultEntry.Tag.FAILURE.

Returns:

The RelocationBatchErrorEntry value associated with this instance if isFailure() is true.

Throws:

IllegalStateException - If isFailure() is false.

isOther

public boolean isOther()

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

Returns:

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