com.dropbox.core.v2.clouddocs

Class LockingErrorTagUnion

java.lang.Object

com.dropbox.core.v2.clouddocs.LockingErrorTagUnion

public final class LockingErrorTagUnion
extends java.lang.Object

This class is an open 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.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LockingErrorTagUnion.Tag Discriminating tag type for LockingErrorTagUnion.

Field Summary

Fields

Modifier and Type	Field and Description
static LockingErrorTagUnion	OTHER Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static LockingErrorTagUnion	genericError(GenericErrorTag value) Returns an instance of LockingErrorTagUnion that has its tag set to LockingErrorTagUnion.Tag.GENERIC_ERROR.
GenericErrorTag	getGenericErrorValue() This instance must be tagged as LockingErrorTagUnion.Tag.GENERIC_ERROR.
LockingErrorTag	getLockingErrorValue() This instance must be tagged as LockingErrorTagUnion.Tag.LOCKING_ERROR.
int	hashCode()
boolean	isGenericError() Returns true if this instance has the tag LockingErrorTagUnion.Tag.GENERIC_ERROR, false otherwise.
boolean	isLockingError() Returns true if this instance has the tag LockingErrorTagUnion.Tag.LOCKING_ERROR, false otherwise.
boolean	isOther() Returns true if this instance has the tag LockingErrorTagUnion.Tag.OTHER, false otherwise.
static LockingErrorTagUnion	lockingError(LockingErrorTag value) Returns an instance of LockingErrorTagUnion that has its tag set to LockingErrorTagUnion.Tag.LOCKING_ERROR.
LockingErrorTagUnion.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

Field Detail

OTHER

public static final LockingErrorTagUnion OTHER

Catch-all used for unknown tag values returned by the Dropbox servers.

Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

Method Detail

tag

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

If a tag returned by the server is unrecognized by this SDK, the LockingErrorTagUnion.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isLockingError

public boolean isLockingError()

Returns true if this instance has the tag LockingErrorTagUnion.Tag.LOCKING_ERROR, false otherwise.

Returns:

true if this instance is tagged as LockingErrorTagUnion.Tag.LOCKING_ERROR, false otherwise.

lockingError

public static LockingErrorTagUnion lockingError(LockingErrorTag value)

Returns an instance of LockingErrorTagUnion that has its tag set to LockingErrorTagUnion.Tag.LOCKING_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of LockingErrorTagUnion with its tag set to LockingErrorTagUnion.Tag.LOCKING_ERROR.

Throws:

java.lang.IllegalArgumentException - if value is null.

getLockingErrorValue

public LockingErrorTag getLockingErrorValue()

This instance must be tagged as LockingErrorTagUnion.Tag.LOCKING_ERROR.

Returns:

The LockingErrorTag value associated with this instance if isLockingError() is true.

Throws:

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

isGenericError

public boolean isGenericError()

Returns true if this instance has the tag LockingErrorTagUnion.Tag.GENERIC_ERROR, false otherwise.

Returns:

true if this instance is tagged as LockingErrorTagUnion.Tag.GENERIC_ERROR, false otherwise.

genericError

public static LockingErrorTagUnion genericError(GenericErrorTag value)

Returns an instance of LockingErrorTagUnion that has its tag set to LockingErrorTagUnion.Tag.GENERIC_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of LockingErrorTagUnion with its tag set to LockingErrorTagUnion.Tag.GENERIC_ERROR.

Throws:

java.lang.IllegalArgumentException - if value is null.

getGenericErrorValue

public GenericErrorTag getGenericErrorValue()

This instance must be tagged as LockingErrorTagUnion.Tag.GENERIC_ERROR.

Returns:

The GenericErrorTag value associated with this instance if isGenericError() is true.

Throws:

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

isOther

public boolean isOther()

Returns true if this instance has the tag LockingErrorTagUnion.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as LockingErrorTagUnion.Tag.OTHER, false otherwise.

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