com.dropbox.core.v2.sharing

Class ShareFolderJobStatus

java.lang.Object

com.dropbox.core.v2.sharing.ShareFolderJobStatus

public final class ShareFolderJobStatus
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 and Description
static class	ShareFolderJobStatus.Tag Discriminating tag type for ShareFolderJobStatus.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static ShareFolderJobStatus	complete(SharedFolderMetadata value) Returns an instance of ShareFolderJobStatus that has its tag set to ShareFolderJobStatus.Tag.COMPLETE.
boolean	equals(Object obj)
static ShareFolderJobStatus	failed(ShareFolderError value) Returns an instance of ShareFolderJobStatus that has its tag set to ShareFolderJobStatus.Tag.FAILED.
SharedFolderMetadata	getCompleteValue() The share job has finished.
ShareFolderError	getFailedValue() This instance must be tagged as ShareFolderJobStatus.Tag.FAILED.
int	hashCode()
boolean	isComplete() Returns true if this instance has the tag ShareFolderJobStatus.Tag.COMPLETE, false otherwise.
boolean	isFailed() Returns true if this instance has the tag ShareFolderJobStatus.Tag.FAILED, false otherwise.
boolean	isInProgress() Returns true if this instance has the tag ShareFolderJobStatus.Tag.IN_PROGRESS, false otherwise.
ShareFolderJobStatus.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

IN_PROGRESS

public static final ShareFolderJobStatus IN_PROGRESS

The asynchronous job is still in progress.

Method Detail

tag

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

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

Returns:

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

isComplete

public boolean isComplete()

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

Returns:

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

complete

public static ShareFolderJobStatus complete(SharedFolderMetadata value)

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

The share job has finished. The value is the metadata for the folder.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getCompleteValue

public SharedFolderMetadata getCompleteValue()

The share job has finished. The value is the metadata for the folder.

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

Returns:

The complete(com.dropbox.core.v2.sharing.SharedFolderMetadata) 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 ShareFolderJobStatus.Tag.FAILED, false otherwise.

Returns:

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

failed

public static ShareFolderJobStatus failed(ShareFolderError value)

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

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getFailedValue

public ShareFolderError getFailedValue()

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

Returns:

The failed(com.dropbox.core.v2.sharing.ShareFolderError) 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