Package com.dropbox.core.v2.team

Class MembersAddJobStatus

java.lang.Object

com.dropbox.core.v2.team.MembersAddJobStatus

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static MembersAddJobStatus	complete(List<MemberAddResult> value)	Returns an instance of MembersAddJobStatus that has its tag set to MembersAddJobStatus.Tag.COMPLETE.
boolean	equals(Object obj)
static MembersAddJobStatus	failed(String value)	Returns an instance of MembersAddJobStatus that has its tag set to MembersAddJobStatus.Tag.FAILED.
List<MemberAddResult>	getCompleteValue()	The asynchronous job has finished.
String	getFailedValue()	The asynchronous job returned an error.
int	hashCode()
boolean	isComplete()	Returns true if this instance has the tag MembersAddJobStatus.Tag.COMPLETE, false otherwise.
boolean	isFailed()	Returns true if this instance has the tag MembersAddJobStatus.Tag.FAILED, false otherwise.
boolean	isInProgress()	Returns true if this instance has the tag MembersAddJobStatus.Tag.IN_PROGRESS, false otherwise.
MembersAddJobStatus.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 MembersAddJobStatus IN_PROGRESS

The asynchronous job is still in progress.

Method Details

tag

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

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

Returns:

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

isComplete

public boolean isComplete()

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

Returns:

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

complete

public static MembersAddJobStatus complete(List<MemberAddResult> value)

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

The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to DbxTeamTeamRequests.membersAdd(List,boolean), a corresponding item is returned in this list.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value contains a null item or is null.

getCompleteValue

public List<MemberAddResult> getCompleteValue()

The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to DbxTeamTeamRequests.membersAdd(List,boolean), a corresponding item is returned in this list.

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

Returns:

The List 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 MembersAddJobStatus.Tag.FAILED, false otherwise.

Returns:

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

failed

public static MembersAddJobStatus failed(String value)

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

The asynchronous job returned an error. The string contains an error message.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getFailedValue

public String getFailedValue()

The asynchronous job returned an error. The string contains an error message.

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

Returns:

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