com.dropbox.core.v2.paper

Class ListDocsCursorError

java.lang.Object

com.dropbox.core.v2.paper.ListDocsCursorError

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

Field Summary

Fields

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

Method Summary

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

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

Returns:

the tag for this instance.

isCursorError

public boolean isCursorError()

Returns true if this instance has the tag ListDocsCursorError.Tag.CURSOR_ERROR, false otherwise.

Returns:

true if this instance is tagged as ListDocsCursorError.Tag.CURSOR_ERROR, false otherwise.

cursorError

public static ListDocsCursorError cursorError(PaperApiCursorError value)

Returns an instance of ListDocsCursorError that has its tag set to ListDocsCursorError.Tag.CURSOR_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of ListDocsCursorError with its tag set to ListDocsCursorError.Tag.CURSOR_ERROR.

Throws:

java.lang.IllegalArgumentException - if value is null.

getCursorErrorValue

public PaperApiCursorError getCursorErrorValue()

This instance must be tagged as ListDocsCursorError.Tag.CURSOR_ERROR.

Returns:

The PaperApiCursorError value associated with this instance if isCursorError() is true.

Throws:

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

isOther

public boolean isOther()

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

Returns:

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