Package com.dropbox.core.v2.files

Class DeleteBatchResultEntry

java.lang.Object

com.dropbox.core.v2.files.DeleteBatchResultEntry

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static DeleteBatchResultEntry	failure(DeleteError value)	Returns an instance of DeleteBatchResultEntry that has its tag set to DeleteBatchResultEntry.Tag.FAILURE.
DeleteError	getFailureValue()	This instance must be tagged as DeleteBatchResultEntry.Tag.FAILURE.
DeleteBatchResultData	getSuccessValue()	This instance must be tagged as DeleteBatchResultEntry.Tag.SUCCESS.
int	hashCode()
boolean	isFailure()	Returns true if this instance has the tag DeleteBatchResultEntry.Tag.FAILURE, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag DeleteBatchResultEntry.Tag.SUCCESS, false otherwise.
static DeleteBatchResultEntry	success(DeleteBatchResultData value)	Returns an instance of DeleteBatchResultEntry that has its tag set to DeleteBatchResultEntry.Tag.SUCCESS.
DeleteBatchResultEntry.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

Method Details

tag

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

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

Returns true if this instance has the tag DeleteBatchResultEntry.Tag.SUCCESS, false otherwise.

Returns:

true if this instance is tagged as DeleteBatchResultEntry.Tag.SUCCESS, false otherwise.

success

public static DeleteBatchResultEntry success(DeleteBatchResultData value)

Returns an instance of DeleteBatchResultEntry that has its tag set to DeleteBatchResultEntry.Tag.SUCCESS.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of DeleteBatchResultEntry with its tag set to DeleteBatchResultEntry.Tag.SUCCESS.

Throws:

IllegalArgumentException - if value is null.

getSuccessValue

public DeleteBatchResultData getSuccessValue()

This instance must be tagged as DeleteBatchResultEntry.Tag.SUCCESS.

Returns:

The DeleteBatchResultData value associated with this instance if isSuccess() is true.

Throws:

IllegalStateException - If isSuccess() is false.

isFailure

public boolean isFailure()

Returns true if this instance has the tag DeleteBatchResultEntry.Tag.FAILURE, false otherwise.

Returns:

true if this instance is tagged as DeleteBatchResultEntry.Tag.FAILURE, false otherwise.

failure

public static DeleteBatchResultEntry failure(DeleteError value)

Returns an instance of DeleteBatchResultEntry that has its tag set to DeleteBatchResultEntry.Tag.FAILURE.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of DeleteBatchResultEntry with its tag set to DeleteBatchResultEntry.Tag.FAILURE.

Throws:

IllegalArgumentException - if value is null.

getFailureValue

public DeleteError getFailureValue()

This instance must be tagged as DeleteBatchResultEntry.Tag.FAILURE.

Returns:

The DeleteError value associated with this instance if isFailure() is true.

Throws:

IllegalStateException - If isFailure() 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