com.dropbox.core.v2.files

Class UploadSessionFinishBatchResultEntry

java.lang.Object

com.dropbox.core.v2.files.UploadSessionFinishBatchResultEntry

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

Method Summary

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

tag

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

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

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

Returns:

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

success

public static UploadSessionFinishBatchResultEntry success(FileMetadata value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getSuccessValue

public FileMetadata getSuccessValue()

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

Returns:

The FileMetadata 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 UploadSessionFinishBatchResultEntry.Tag.FAILURE, false otherwise.

Returns:

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

failure

public static UploadSessionFinishBatchResultEntry failure(UploadSessionFinishError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getFailureValue

public UploadSessionFinishError getFailureValue()

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

Returns:

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