com.dropbox.core.v2.async

Class LaunchEmptyResult

java.lang.Object

com.dropbox.core.v2.async.LaunchEmptyResult

public final class LaunchEmptyResult
extends Object

Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.

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	LaunchEmptyResult.Serializer For internal use only.
static class	LaunchEmptyResult.Tag Discriminating tag type for LaunchEmptyResult.

Field Summary

Fields

Modifier and Type	Field and Description
static LaunchEmptyResult	COMPLETE The job finished synchronously and successfully.

Method Summary

Modifier and Type	Method and Description
static LaunchEmptyResult	asyncJobId(String value) Returns an instance of LaunchEmptyResult that has its tag set to LaunchEmptyResult.Tag.ASYNC_JOB_ID.
boolean	equals(Object obj)
String	getAsyncJobIdValue() This response indicates that the processing is asynchronous.
int	hashCode()
boolean	isAsyncJobId() Returns true if this instance has the tag LaunchEmptyResult.Tag.ASYNC_JOB_ID, false otherwise.
boolean	isComplete() Returns true if this instance has the tag LaunchEmptyResult.Tag.COMPLETE, false otherwise.
LaunchEmptyResult.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 Detail

COMPLETE

public static final LaunchEmptyResult COMPLETE

The job finished synchronously and successfully.

Method Detail

tag

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

Returns:

the tag for this instance.

isAsyncJobId

public boolean isAsyncJobId()

Returns true if this instance has the tag LaunchEmptyResult.Tag.ASYNC_JOB_ID, false otherwise.

Returns:

true if this instance is tagged as LaunchEmptyResult.Tag.ASYNC_JOB_ID, false otherwise.

asyncJobId

public static LaunchEmptyResult asyncJobId(String value)

Returns an instance of LaunchEmptyResult that has its tag set to LaunchEmptyResult.Tag.ASYNC_JOB_ID.

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

Parameters:

value - value to assign to this instance.

Returns:

Instance of LaunchEmptyResult with its tag set to LaunchEmptyResult.Tag.ASYNC_JOB_ID.

Throws:

IllegalArgumentException - if value is shorter than 1 or is null.

getAsyncJobIdValue

public String getAsyncJobIdValue()

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

This instance must be tagged as LaunchEmptyResult.Tag.ASYNC_JOB_ID.

Returns:

The String value associated with this instance if isAsyncJobId() is true.

Throws:

IllegalStateException - If isAsyncJobId() is false.

isComplete

public boolean isComplete()

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

Returns:

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

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