Package com.dropbox.core.v2.files
Class PaperUpdateError
- java.lang.Object
-
- com.dropbox.core.v2.files.PaperUpdateError
-
public final class PaperUpdateError 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 theisAbc()
methods will returntrue
. You can usetag()
to determine the tag associated with this instance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PaperUpdateError.Tag
Discriminating tag type forPaperUpdateError
.
-
Field Summary
Fields Modifier and Type Field Description static PaperUpdateError
CONTENT_MALFORMED
The provided content was malformed and cannot be imported to Paper.static PaperUpdateError
DOC_ARCHIVED
This operation is not allowed on archived Paper docs.static PaperUpdateError
DOC_DELETED
This operation is not allowed on deleted Paper docs.static PaperUpdateError
DOC_LENGTH_EXCEEDED
The Paper doc would be too large, split the content into multiple docs.static PaperUpdateError
IMAGE_SIZE_EXCEEDED
The imported document contains an image that is too large.static PaperUpdateError
INSUFFICIENT_PERMISSIONS
Your account does not have permissions to edit Paper docs.static PaperUpdateError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static PaperUpdateError
REVISION_MISMATCH
The provided revision does not match the document head.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
LookupError
getPathValue()
This instance must be tagged asPaperUpdateError.Tag.PATH
.int
hashCode()
boolean
isContentMalformed()
boolean
isDocArchived()
boolean
isDocDeleted()
boolean
isDocLengthExceeded()
Returnstrue
if this instance has the tagPaperUpdateError.Tag.DOC_LENGTH_EXCEEDED
,false
otherwise.boolean
isImageSizeExceeded()
Returnstrue
if this instance has the tagPaperUpdateError.Tag.IMAGE_SIZE_EXCEEDED
,false
otherwise.boolean
isInsufficientPermissions()
Returnstrue
if this instance has the tagPaperUpdateError.Tag.INSUFFICIENT_PERMISSIONS
,false
otherwise.boolean
isOther()
boolean
isPath()
boolean
isRevisionMismatch()
static PaperUpdateError
path(LookupError value)
Returns an instance ofPaperUpdateError
that has its tag set toPaperUpdateError.Tag.PATH
.PaperUpdateError.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.
-
-
-
Field Detail
-
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 Detail
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisPaperUpdateError
.- Returns:
- the tag for this instance.
-
isInsufficientPermissions
public boolean isInsufficientPermissions()
Returnstrue
if this instance has the tagPaperUpdateError.Tag.INSUFFICIENT_PERMISSIONS
,false
otherwise.- Returns:
true
if this instance is tagged asPaperUpdateError.Tag.INSUFFICIENT_PERMISSIONS
,false
otherwise.
-
isContentMalformed
public boolean isContentMalformed()
- Returns:
true
if this instance is tagged asPaperUpdateError.Tag.CONTENT_MALFORMED
,false
otherwise.
-
isDocLengthExceeded
public boolean isDocLengthExceeded()
Returnstrue
if this instance has the tagPaperUpdateError.Tag.DOC_LENGTH_EXCEEDED
,false
otherwise.- Returns:
true
if this instance is tagged asPaperUpdateError.Tag.DOC_LENGTH_EXCEEDED
,false
otherwise.
-
isImageSizeExceeded
public boolean isImageSizeExceeded()
Returnstrue
if this instance has the tagPaperUpdateError.Tag.IMAGE_SIZE_EXCEEDED
,false
otherwise.- Returns:
true
if this instance is tagged asPaperUpdateError.Tag.IMAGE_SIZE_EXCEEDED
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asPaperUpdateError.Tag.OTHER
,false
otherwise.
-
isPath
public boolean isPath()
- Returns:
true
if this instance is tagged asPaperUpdateError.Tag.PATH
,false
otherwise.
-
path
public static PaperUpdateError path(LookupError value)
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
PaperUpdateError
with its tag set toPaperUpdateError.Tag.PATH
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getPathValue
public LookupError getPathValue()
This instance must be tagged asPaperUpdateError.Tag.PATH
.- Returns:
- The
LookupError
value associated with this instance ifisPath()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPath()
isfalse
.
-
isRevisionMismatch
public boolean isRevisionMismatch()
- Returns:
true
if this instance is tagged asPaperUpdateError.Tag.REVISION_MISMATCH
,false
otherwise.
-
isDocArchived
public boolean isDocArchived()
- Returns:
true
if this instance is tagged asPaperUpdateError.Tag.DOC_ARCHIVED
,false
otherwise.
-
isDocDeleted
public boolean isDocDeleted()
- Returns:
true
if this instance is tagged asPaperUpdateError.Tag.DOC_DELETED
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.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
-
-