Package com.dropbox.core.v2.files

Class SaveUrlJobStatus

java.lang.Object

com.dropbox.core.v2.files.SaveUrlJobStatus

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static SaveUrlJobStatus	complete(FileMetadata value)	Returns an instance of SaveUrlJobStatus that has its tag set to SaveUrlJobStatus.Tag.COMPLETE.
boolean	equals(Object obj)
static SaveUrlJobStatus	failed(SaveUrlError value)	Returns an instance of SaveUrlJobStatus that has its tag set to SaveUrlJobStatus.Tag.FAILED.
FileMetadata	getCompleteValue()	Metadata of the file where the URL is saved to.
SaveUrlError	getFailedValue()	This instance must be tagged as SaveUrlJobStatus.Tag.FAILED.
int	hashCode()
boolean	isComplete()	Returns true if this instance has the tag SaveUrlJobStatus.Tag.COMPLETE, false otherwise.
boolean	isFailed()	Returns true if this instance has the tag SaveUrlJobStatus.Tag.FAILED, false otherwise.
boolean	isInProgress()	Returns true if this instance has the tag SaveUrlJobStatus.Tag.IN_PROGRESS, false otherwise.
SaveUrlJobStatus.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 SaveUrlJobStatus IN_PROGRESS

The asynchronous job is still in progress.

Method Details

tag

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

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

Returns:

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

isComplete

public boolean isComplete()

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

Returns:

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

complete

public static SaveUrlJobStatus complete(FileMetadata value)

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

Metadata of the file where the URL is saved to.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getCompleteValue

public FileMetadata getCompleteValue()

Metadata of the file where the URL is saved to.

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

Returns:

The FileMetadata 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 SaveUrlJobStatus.Tag.FAILED, false otherwise.

Returns:

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

failed

public static SaveUrlJobStatus failed(SaveUrlError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getFailedValue

public SaveUrlError getFailedValue()

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

Returns:

The SaveUrlError 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