Package com.dropbox.core.v2.team

Class TeamFolderArchiveJobStatus

java.lang.Object

com.dropbox.core.v2.team.TeamFolderArchiveJobStatus

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static TeamFolderArchiveJobStatus	complete(TeamFolderMetadata value)	Returns an instance of TeamFolderArchiveJobStatus that has its tag set to TeamFolderArchiveJobStatus.Tag.COMPLETE.
boolean	equals(Object obj)
static TeamFolderArchiveJobStatus	failed(TeamFolderArchiveError value)	Returns an instance of TeamFolderArchiveJobStatus that has its tag set to TeamFolderArchiveJobStatus.Tag.FAILED.
TeamFolderMetadata	getCompleteValue()	The archive job has finished.
TeamFolderArchiveError	getFailedValue()	Error occurred while performing an asynchronous job from DbxTeamTeamRequests.teamFolderArchive(String,boolean).
int	hashCode()
boolean	isComplete()	Returns true if this instance has the tag TeamFolderArchiveJobStatus.Tag.COMPLETE, false otherwise.
boolean	isFailed()	Returns true if this instance has the tag TeamFolderArchiveJobStatus.Tag.FAILED, false otherwise.
boolean	isInProgress()	Returns true if this instance has the tag TeamFolderArchiveJobStatus.Tag.IN_PROGRESS, false otherwise.
TeamFolderArchiveJobStatus.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 TeamFolderArchiveJobStatus IN_PROGRESS

The asynchronous job is still in progress.

Method Details

tag

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

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

Returns:

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

isComplete

public boolean isComplete()

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

Returns:

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

complete

public static TeamFolderArchiveJobStatus complete(TeamFolderMetadata value)

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

The archive job has finished. The value is the metadata for the resulting team folder.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getCompleteValue

public TeamFolderMetadata getCompleteValue()

The archive job has finished. The value is the metadata for the resulting team folder.

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

Returns:

The TeamFolderMetadata 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 TeamFolderArchiveJobStatus.Tag.FAILED, false otherwise.

Returns:

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

failed

public static TeamFolderArchiveJobStatus failed(TeamFolderArchiveError value)

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

Error occurred while performing an asynchronous job from DbxTeamTeamRequests.teamFolderArchive(String,boolean).

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getFailedValue

public TeamFolderArchiveError getFailedValue()

Error occurred while performing an asynchronous job from DbxTeamTeamRequests.teamFolderArchive(String,boolean).

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

Returns:

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