com.dropbox.core.v2.files

Class DeleteBatchJobStatus

java.lang.Object

com.dropbox.core.v2.files.DeleteBatchJobStatus

public final class DeleteBatchJobStatus
extends java.lang.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	DeleteBatchJobStatus.Tag Discriminating tag type for DeleteBatchJobStatus.

Field Summary

Fields

Modifier and Type	Field and Description
static DeleteBatchJobStatus	IN_PROGRESS The asynchronous job is still in progress.
static DeleteBatchJobStatus	OTHER Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method and Description
static DeleteBatchJobStatus	complete(DeleteBatchResult value) Returns an instance of DeleteBatchJobStatus that has its tag set to DeleteBatchJobStatus.Tag.COMPLETE.
boolean	equals(java.lang.Object obj)
static DeleteBatchJobStatus	failed(DeleteBatchError value) Returns an instance of DeleteBatchJobStatus that has its tag set to DeleteBatchJobStatus.Tag.FAILED.
DeleteBatchResult	getCompleteValue() The batch delete has finished.
DeleteBatchError	getFailedValue() The batch delete has failed.
int	hashCode()
boolean	isComplete() Returns true if this instance has the tag DeleteBatchJobStatus.Tag.COMPLETE, false otherwise.
boolean	isFailed() Returns true if this instance has the tag DeleteBatchJobStatus.Tag.FAILED, false otherwise.
boolean	isInProgress() Returns true if this instance has the tag DeleteBatchJobStatus.Tag.IN_PROGRESS, false otherwise.
boolean	isOther() Returns true if this instance has the tag DeleteBatchJobStatus.Tag.OTHER, false otherwise.
DeleteBatchJobStatus.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 DeleteBatchJobStatus IN_PROGRESS

The asynchronous job is still in progress.

OTHER

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

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

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

Returns:

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

isComplete

public boolean isComplete()

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

Returns:

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

complete

public static DeleteBatchJobStatus complete(DeleteBatchResult value)

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

The batch delete has finished.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if value is null.

getCompleteValue

public DeleteBatchResult getCompleteValue()

The batch delete has finished.

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

Returns:

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

Throws:

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

isFailed

public boolean isFailed()

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

Returns:

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

failed

public static DeleteBatchJobStatus failed(DeleteBatchError value)

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

The batch delete has failed.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if value is null.

getFailedValue

public DeleteBatchError getFailedValue()

The batch delete has failed.

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

Returns:

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

Throws:

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

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as DeleteBatchJobStatus.Tag.OTHER, false otherwise.

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