Package com.dropbox.core.v2.files

Class RelocationBatchJobStatus

java.lang.Object

com.dropbox.core.v2.files.RelocationBatchJobStatus

public final class RelocationBatchJobStatus
extends Object

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	Description
static enum	RelocationBatchJobStatus.Tag	Discriminating tag type for RelocationBatchJobStatus.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static RelocationBatchJobStatus	complete(RelocationBatchResult value)	Returns an instance of RelocationBatchJobStatus that has its tag set to RelocationBatchJobStatus.Tag.COMPLETE.
boolean	equals(Object obj)
static RelocationBatchJobStatus	failed(RelocationBatchError value)	Returns an instance of RelocationBatchJobStatus that has its tag set to RelocationBatchJobStatus.Tag.FAILED.
RelocationBatchResult	getCompleteValue()	The copy or move batch job has finished.
RelocationBatchError	getFailedValue()	The copy or move batch job has failed with exception.
int	hashCode()
boolean	isComplete()	Returns true if this instance has the tag RelocationBatchJobStatus.Tag.COMPLETE, false otherwise.
boolean	isFailed()	Returns true if this instance has the tag RelocationBatchJobStatus.Tag.FAILED, false otherwise.
boolean	isInProgress()	Returns true if this instance has the tag RelocationBatchJobStatus.Tag.IN_PROGRESS, false otherwise.
RelocationBatchJobStatus.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

IN_PROGRESS

public static final RelocationBatchJobStatus IN_PROGRESS

The asynchronous job is still in progress.

Method Details

tag

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

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

Returns:

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

isComplete

public boolean isComplete()

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

Returns:

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

complete

public static RelocationBatchJobStatus complete(RelocationBatchResult value)

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

The copy or move batch job has finished.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getCompleteValue

public RelocationBatchResult getCompleteValue()

The copy or move batch job has finished.

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

Returns:

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

Throws:

IllegalStateException - If isComplete() is false.

isFailed

public boolean isFailed()

Returns true if this instance has the tag RelocationBatchJobStatus.Tag.FAILED, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchJobStatus.Tag.FAILED, false otherwise.

failed

public static RelocationBatchJobStatus failed(RelocationBatchError value)

Returns an instance of RelocationBatchJobStatus that has its tag set to RelocationBatchJobStatus.Tag.FAILED.

The copy or move batch job has failed with exception.

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchJobStatus with its tag set to RelocationBatchJobStatus.Tag.FAILED.

Throws:

IllegalArgumentException - if value is null.

getFailedValue

public RelocationBatchError getFailedValue()

The copy or move batch job has failed with exception.

This instance must be tagged as RelocationBatchJobStatus.Tag.FAILED.

Returns:

The RelocationBatchError value associated with this instance if isFailed() is true.

Throws:

IllegalStateException - If isFailed() is false.

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