Class WriteError
- java.lang.Object
- 
- com.dropbox.core.v2.files.WriteError
 
- 
 public final class WriteError extends java.lang.ObjectThis class is an open 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.Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHERvalue will be used.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classWriteError.TagDiscriminating tag type forWriteError.
 - 
Field SummaryFields Modifier and Type Field Description static WriteErrorDISALLOWED_NAMEDropbox will not save the file or folder because of its name.static WriteErrorINSUFFICIENT_SPACEThe user doesn't have enough available space (bytes) to write more data.static WriteErrorNO_WRITE_PERMISSIONThe user doesn't have permissions to write to the target location.static WriteErrorOPERATION_SUPPRESSEDThis file operation is not allowed at this path.static WriteErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static WriteErrorTEAM_FOLDERThis endpoint cannot move or delete team folders.static WriteErrorTOO_MANY_WRITE_OPERATIONSThere are too many write operations in user's Dropbox.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WriteErrorconflict(WriteConflictError value)Returns an instance ofWriteErrorthat has its tag set toWriteError.Tag.CONFLICT.booleanequals(java.lang.Object obj)WriteConflictErrorgetConflictValue()Couldn't write to the target path because there was something in the way.java.lang.StringgetMalformedPathValue()The given path does not satisfy the required path format.inthashCode()booleanisConflict()booleanisDisallowedName()booleanisInsufficientSpace()booleanisMalformedPath()booleanisNoWritePermission()booleanisOperationSuppressed()booleanisOther()booleanisTeamFolder()booleanisTooManyWriteOperations()Returnstrueif this instance has the tagWriteError.Tag.TOO_MANY_WRITE_OPERATIONS,falseotherwise.static WriteErrormalformedPath()Returns an instance ofWriteErrorthat has its tag set toWriteError.Tag.MALFORMED_PATH.static WriteErrormalformedPath(java.lang.String value)Returns an instance ofWriteErrorthat has its tag set toWriteError.Tag.MALFORMED_PATH.WriteError.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.
 
- 
- 
- 
Field Detail- 
NO_WRITE_PERMISSIONpublic static final WriteError NO_WRITE_PERMISSION The user doesn't have permissions to write to the target location.
 - 
INSUFFICIENT_SPACEpublic static final WriteError INSUFFICIENT_SPACE The user doesn't have enough available space (bytes) to write more data.
 - 
DISALLOWED_NAMEpublic static final WriteError DISALLOWED_NAME Dropbox will not save the file or folder because of its name.
 - 
TEAM_FOLDERpublic static final WriteError TEAM_FOLDER This endpoint cannot move or delete team folders.
 - 
OPERATION_SUPPRESSEDpublic static final WriteError OPERATION_SUPPRESSED This file operation is not allowed at this path.
 - 
TOO_MANY_WRITE_OPERATIONSpublic static final WriteError TOO_MANY_WRITE_OPERATIONS There are too many write operations in user's Dropbox. Please retry this request.
 - 
OTHERpublic static final WriteError 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- 
tagpublic WriteError.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 aswitchstatement to properly handle the different values for thisWriteError.If a tag returned by the server is unrecognized by this SDK, the WriteError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
 
 - 
isMalformedPathpublic boolean isMalformedPath() - Returns:
- trueif this instance is tagged as- WriteError.Tag.MALFORMED_PATH,- falseotherwise.
 
 - 
malformedPathpublic static WriteError malformedPath(java.lang.String value) Returns an instance ofWriteErrorthat has its tag set toWriteError.Tag.MALFORMED_PATH.The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information. - Parameters:
- value- value to assign to this instance.
- Returns:
- Instance of WriteErrorwith its tag set toWriteError.Tag.MALFORMED_PATH.
 
 - 
malformedPathpublic static WriteError malformedPath() Returns an instance ofWriteErrorthat has its tag set toWriteError.Tag.MALFORMED_PATH.The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information. - Returns:
- Instance of WriteErrorwith its tag set toWriteError.Tag.MALFORMED_PATH.
 
 - 
getMalformedPathValuepublic java.lang.String getMalformedPathValue() The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.This instance must be tagged as WriteError.Tag.MALFORMED_PATH.- Returns:
- The Stringvalue associated with this instance ifisMalformedPath()istrue.
- Throws:
- java.lang.IllegalStateException- If- isMalformedPath()is- false.
 
 - 
isConflictpublic boolean isConflict() - Returns:
- trueif this instance is tagged as- WriteError.Tag.CONFLICT,- falseotherwise.
 
 - 
conflictpublic static WriteError conflict(WriteConflictError value) Returns an instance ofWriteErrorthat has its tag set toWriteError.Tag.CONFLICT.Couldn't write to the target path because there was something in the way. - Parameters:
- value- value to assign to this instance.
- Returns:
- Instance of WriteErrorwith its tag set toWriteError.Tag.CONFLICT.
- Throws:
- java.lang.IllegalArgumentException- if- valueis- null.
 
 - 
getConflictValuepublic WriteConflictError getConflictValue() Couldn't write to the target path because there was something in the way.This instance must be tagged as WriteError.Tag.CONFLICT.- Returns:
- The WriteConflictErrorvalue associated with this instance ifisConflict()istrue.
- Throws:
- java.lang.IllegalStateException- If- isConflict()is- false.
 
 - 
isNoWritePermissionpublic boolean isNoWritePermission() - Returns:
- trueif this instance is tagged as- WriteError.Tag.NO_WRITE_PERMISSION,- falseotherwise.
 
 - 
isInsufficientSpacepublic boolean isInsufficientSpace() - Returns:
- trueif this instance is tagged as- WriteError.Tag.INSUFFICIENT_SPACE,- falseotherwise.
 
 - 
isDisallowedNamepublic boolean isDisallowedName() - Returns:
- trueif this instance is tagged as- WriteError.Tag.DISALLOWED_NAME,- falseotherwise.
 
 - 
isTeamFolderpublic boolean isTeamFolder() - Returns:
- trueif this instance is tagged as- WriteError.Tag.TEAM_FOLDER,- falseotherwise.
 
 - 
isOperationSuppressedpublic boolean isOperationSuppressed() - Returns:
- trueif this instance is tagged as- WriteError.Tag.OPERATION_SUPPRESSED,- falseotherwise.
 
 - 
isTooManyWriteOperationspublic boolean isTooManyWriteOperations() Returnstrueif this instance has the tagWriteError.Tag.TOO_MANY_WRITE_OPERATIONS,falseotherwise.- Returns:
- trueif this instance is tagged as- WriteError.Tag.TOO_MANY_WRITE_OPERATIONS,- falseotherwise.
 
 - 
isOtherpublic boolean isOther() - Returns:
- trueif this instance is tagged as- WriteError.Tag.OTHER,- falseotherwise.
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- java.lang.Object
 
 - 
equalspublic boolean equals(java.lang.Object obj) - Overrides:
- equalsin class- java.lang.Object
 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 - 
toStringMultilinepublic 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
 
 
- 
 
-