Package com.dropbox.core.v2.openid

Class ErrUnion

java.lang.Object

com.dropbox.core.v2.openid.ErrUnion

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ErrUnion	authError(AuthError value)	Returns an instance of ErrUnion that has its tag set to ErrUnion.Tag.AUTH_ERROR.
boolean	equals(java.lang.Object obj)
AuthError	getAuthErrorValue()	This instance must be tagged as ErrUnion.Tag.AUTH_ERROR.
int	hashCode()
boolean	isAuthError()	Returns true if this instance has the tag ErrUnion.Tag.AUTH_ERROR, false otherwise.
boolean	isOther()	Returns true if this instance has the tag ErrUnion.Tag.OTHER, false otherwise.
ErrUnion.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 ErrUnion 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 ErrUnion.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 ErrUnion.

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

Returns:

the tag for this instance.

isAuthError

public boolean isAuthError()

Returns true if this instance has the tag ErrUnion.Tag.AUTH_ERROR, false otherwise.

Returns:

true if this instance is tagged as ErrUnion.Tag.AUTH_ERROR, false otherwise.

authError

public static ErrUnion authError(AuthError value)

Returns an instance of ErrUnion that has its tag set to ErrUnion.Tag.AUTH_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of ErrUnion with its tag set to ErrUnion.Tag.AUTH_ERROR.

Throws:

java.lang.IllegalArgumentException - if value is null.

getAuthErrorValue

public AuthError getAuthErrorValue()

This instance must be tagged as ErrUnion.Tag.AUTH_ERROR.

Returns:

The AuthError value associated with this instance if isAuthError() is true.

Throws:

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

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as ErrUnion.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