com.dropbox.core.v2.files

Class RelocationBatchV2JobStatus

java.lang.Object

com.dropbox.core.v2.files.RelocationBatchV2JobStatus

public final class RelocationBatchV2JobStatus
extends java.lang.Object

Result returned by DbxUserFilesRequests.copyBatchV2(java.util.List,boolean) or DbxUserFilesRequests.moveBatchV2(java.util.List) that may either launch an asynchronous job or complete synchronously.

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

Field Summary

Fields

Modifier and Type	Field and Description
static RelocationBatchV2JobStatus	IN_PROGRESS The asynchronous job is still in progress.

Method Summary

Modifier and Type	Method and Description
static RelocationBatchV2JobStatus	complete(RelocationBatchV2Result value) Returns an instance of RelocationBatchV2JobStatus that has its tag set to RelocationBatchV2JobStatus.Tag.COMPLETE.
boolean	equals(java.lang.Object obj)
RelocationBatchV2Result	getCompleteValue() The copy or move batch job has finished.
int	hashCode()
boolean	isComplete() Returns true if this instance has the tag RelocationBatchV2JobStatus.Tag.COMPLETE, false otherwise.
boolean	isInProgress() Returns true if this instance has the tag RelocationBatchV2JobStatus.Tag.IN_PROGRESS, false otherwise.
RelocationBatchV2JobStatus.Tag	tag() Returns the tag for this instance.
java.lang.String	toString()
java.lang.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

IN_PROGRESS

public static final RelocationBatchV2JobStatus IN_PROGRESS

The asynchronous job is still in progress.

Method Detail

tag

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

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

Returns:

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

isComplete

public boolean isComplete()

Returns true if this instance has the tag RelocationBatchV2JobStatus.Tag.COMPLETE, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchV2JobStatus.Tag.COMPLETE, false otherwise.

complete

public static RelocationBatchV2JobStatus complete(RelocationBatchV2Result value)

Returns an instance of RelocationBatchV2JobStatus that has its tag set to RelocationBatchV2JobStatus.Tag.COMPLETE.

The copy or move batch job has finished.

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchV2JobStatus with its tag set to RelocationBatchV2JobStatus.Tag.COMPLETE.

Throws:

java.lang.IllegalArgumentException - if value is null.

getCompleteValue

public RelocationBatchV2Result getCompleteValue()

The copy or move batch job has finished.

This instance must be tagged as RelocationBatchV2JobStatus.Tag.COMPLETE.

Returns:

The RelocationBatchV2Result value associated with this instance if isComplete() is true.

Throws:

java.lang.IllegalStateException - If isComplete() is false.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

public java.lang.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