Package com.dropbox.core.v2.files

Class PaperUpdateError

java.lang.Object

com.dropbox.core.v2.files.PaperUpdateError

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

Field Summary

Fields

Modifier and Type	Field	Description
static final PaperUpdateError	CONTENT_MALFORMED	The provided content was malformed and cannot be imported to Paper.
static final PaperUpdateError	DOC_ARCHIVED	This operation is not allowed on archived Paper docs.
static final PaperUpdateError	DOC_DELETED	This operation is not allowed on deleted Paper docs.
static final PaperUpdateError	DOC_LENGTH_EXCEEDED	The Paper doc would be too large, split the content into multiple docs.
static final PaperUpdateError	IMAGE_SIZE_EXCEEDED	The imported document contains an image that is too large.
static final PaperUpdateError	INSUFFICIENT_PERMISSIONS	Your account does not have permissions to edit Paper docs.
static final PaperUpdateError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final PaperUpdateError	REVISION_MISMATCH	The provided revision does not match the document head.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
LookupError	getPathValue()	This instance must be tagged as PaperUpdateError.Tag.PATH.
int	hashCode()
boolean	isContentMalformed()	Returns true if this instance has the tag PaperUpdateError.Tag.CONTENT_MALFORMED, false otherwise.
boolean	isDocArchived()	Returns true if this instance has the tag PaperUpdateError.Tag.DOC_ARCHIVED, false otherwise.
boolean	isDocDeleted()	Returns true if this instance has the tag PaperUpdateError.Tag.DOC_DELETED, false otherwise.
boolean	isDocLengthExceeded()	Returns true if this instance has the tag PaperUpdateError.Tag.DOC_LENGTH_EXCEEDED, false otherwise.
boolean	isImageSizeExceeded()	Returns true if this instance has the tag PaperUpdateError.Tag.IMAGE_SIZE_EXCEEDED, false otherwise.
boolean	isInsufficientPermissions()	Returns true if this instance has the tag PaperUpdateError.Tag.INSUFFICIENT_PERMISSIONS, false otherwise.
boolean	isOther()	Returns true if this instance has the tag PaperUpdateError.Tag.OTHER, false otherwise.
boolean	isPath()	Returns true if this instance has the tag PaperUpdateError.Tag.PATH, false otherwise.
boolean	isRevisionMismatch()	Returns true if this instance has the tag PaperUpdateError.Tag.REVISION_MISMATCH, false otherwise.
static PaperUpdateError	path(LookupError value)	Returns an instance of PaperUpdateError that has its tag set to PaperUpdateError.Tag.PATH.
PaperUpdateError.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

Field Details

INSUFFICIENT_PERMISSIONS

public static final PaperUpdateError INSUFFICIENT_PERMISSIONS

Your account does not have permissions to edit Paper docs.

CONTENT_MALFORMED

public static final PaperUpdateError CONTENT_MALFORMED

The provided content was malformed and cannot be imported to Paper.

DOC_LENGTH_EXCEEDED

public static final PaperUpdateError DOC_LENGTH_EXCEEDED

The Paper doc would be too large, split the content into multiple docs.

IMAGE_SIZE_EXCEEDED

public static final PaperUpdateError IMAGE_SIZE_EXCEEDED

The imported document contains an image that is too large. The current limit is 1MB. This only applies to HTML with data URI.

OTHER

public static final PaperUpdateError 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.

REVISION_MISMATCH

public static final PaperUpdateError REVISION_MISMATCH

The provided revision does not match the document head.

DOC_ARCHIVED

public static final PaperUpdateError DOC_ARCHIVED

This operation is not allowed on archived Paper docs.

DOC_DELETED

public static final PaperUpdateError DOC_DELETED

This operation is not allowed on deleted Paper docs.

Method Details

tag

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

Returns:

the tag for this instance.

isInsufficientPermissions

public boolean isInsufficientPermissions()

Returns true if this instance has the tag PaperUpdateError.Tag.INSUFFICIENT_PERMISSIONS, false otherwise.

Returns:

true if this instance is tagged as PaperUpdateError.Tag.INSUFFICIENT_PERMISSIONS, false otherwise.

isContentMalformed

public boolean isContentMalformed()

Returns true if this instance has the tag PaperUpdateError.Tag.CONTENT_MALFORMED, false otherwise.

Returns:

true if this instance is tagged as PaperUpdateError.Tag.CONTENT_MALFORMED, false otherwise.

isDocLengthExceeded

public boolean isDocLengthExceeded()

Returns true if this instance has the tag PaperUpdateError.Tag.DOC_LENGTH_EXCEEDED, false otherwise.

Returns:

true if this instance is tagged as PaperUpdateError.Tag.DOC_LENGTH_EXCEEDED, false otherwise.

isImageSizeExceeded

public boolean isImageSizeExceeded()

Returns true if this instance has the tag PaperUpdateError.Tag.IMAGE_SIZE_EXCEEDED, false otherwise.

Returns:

true if this instance is tagged as PaperUpdateError.Tag.IMAGE_SIZE_EXCEEDED, false otherwise.

isOther

public boolean isOther()

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

Returns:

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

isPath

public boolean isPath()

Returns true if this instance has the tag PaperUpdateError.Tag.PATH, false otherwise.

Returns:

true if this instance is tagged as PaperUpdateError.Tag.PATH, false otherwise.

path

public static PaperUpdateError path(LookupError value)

Returns an instance of PaperUpdateError that has its tag set to PaperUpdateError.Tag.PATH.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of PaperUpdateError with its tag set to PaperUpdateError.Tag.PATH.

Throws:

IllegalArgumentException - if value is null.

getPathValue

public LookupError getPathValue()

This instance must be tagged as PaperUpdateError.Tag.PATH.

Returns:

The LookupError value associated with this instance if isPath() is true.

Throws:

IllegalStateException - If isPath() is false.

isRevisionMismatch

public boolean isRevisionMismatch()

Returns true if this instance has the tag PaperUpdateError.Tag.REVISION_MISMATCH, false otherwise.

Returns:

true if this instance is tagged as PaperUpdateError.Tag.REVISION_MISMATCH, false otherwise.

isDocArchived

public boolean isDocArchived()

Returns true if this instance has the tag PaperUpdateError.Tag.DOC_ARCHIVED, false otherwise.

Returns:

true if this instance is tagged as PaperUpdateError.Tag.DOC_ARCHIVED, false otherwise.

isDocDeleted

public boolean isDocDeleted()

Returns true if this instance has the tag PaperUpdateError.Tag.DOC_DELETED, false otherwise.

Returns:

true if this instance is tagged as PaperUpdateError.Tag.DOC_DELETED, false otherwise.

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