Package com.dropbox.core.v2.files

Class UploadSessionFinishBatchJobStatus

java.lang.Object

com.dropbox.core.v2.files.UploadSessionFinishBatchJobStatus

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static UploadSessionFinishBatchJobStatus	complete(UploadSessionFinishBatchResult value)	Returns an instance of UploadSessionFinishBatchJobStatus that has its tag set to UploadSessionFinishBatchJobStatus.Tag.COMPLETE.
boolean	equals(Object obj)
UploadSessionFinishBatchResult	getCompleteValue()	The DbxUserFilesRequests.uploadSessionFinishBatch(java.util.List) has finished.
int	hashCode()
boolean	isComplete()	Returns true if this instance has the tag UploadSessionFinishBatchJobStatus.Tag.COMPLETE, false otherwise.
boolean	isInProgress()	Returns true if this instance has the tag UploadSessionFinishBatchJobStatus.Tag.IN_PROGRESS, false otherwise.
UploadSessionFinishBatchJobStatus.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 UploadSessionFinishBatchJobStatus IN_PROGRESS

The asynchronous job is still in progress.

Method Details

tag

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

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

Returns:

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

isComplete

public boolean isComplete()

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

Returns:

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

complete

public static UploadSessionFinishBatchJobStatus complete(UploadSessionFinishBatchResult value)

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

The DbxUserFilesRequests.uploadSessionFinishBatch(java.util.List) has finished.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getCompleteValue

public UploadSessionFinishBatchResult getCompleteValue()

The DbxUserFilesRequests.uploadSessionFinishBatch(java.util.List) has finished.

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

Returns:

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

Throws:

IllegalStateException - If isComplete() 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