com.dropbox.core.v2.files

Class LockFileResultEntry

java.lang.Object

com.dropbox.core.v2.files.LockFileResultEntry

public final class LockFileResultEntry
extends java.lang.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	LockFileResultEntry.Tag Discriminating tag type for LockFileResultEntry.

Method Summary

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

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

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

Returns:

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

success

public static LockFileResultEntry success(LockFileResult value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if value is null.

getSuccessValue

public LockFileResult getSuccessValue()

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

Returns:

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

Throws:

java.lang.IllegalStateException - If isSuccess() is false.

isFailure

public boolean isFailure()

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

Returns:

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

failure

public static LockFileResultEntry failure(LockFileError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if value is null.

getFailureValue

public LockFileError getFailureValue()

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

Returns:

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

Throws:

java.lang.IllegalStateException - If isFailure() is false.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

public java.lang.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