Package com.dropbox.core.v2.files

Class CreateFolderBatchResultEntry

java.lang.Object

com.dropbox.core.v2.files.CreateFolderBatchResultEntry

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

Method Summary

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

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

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

Returns:

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

success

public static CreateFolderBatchResultEntry success(CreateFolderEntryResult value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getSuccessValue

public CreateFolderEntryResult getSuccessValue()

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

Returns:

The CreateFolderEntryResult 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 CreateFolderBatchResultEntry.Tag.FAILURE, false otherwise.

Returns:

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

failure

public static CreateFolderBatchResultEntry failure(CreateFolderEntryError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getFailureValue

public CreateFolderEntryError getFailureValue()

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

Returns:

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