Class LockFileError
- java.lang.Object
- 
- com.dropbox.core.v2.files.LockFileError
 
- 
 public final class LockFileError 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 classLockFileError.TagDiscriminating tag type forLockFileError.
 - 
Field SummaryFields Modifier and Type Field Description static LockFileErrorCANNOT_BE_LOCKEDItem is a type that cannot be locked.static LockFileErrorFILE_NOT_SHAREDRequested file is not currently shared.static LockFileErrorINTERNAL_ERRORSomething went wrong with the job on Dropbox's end.static LockFileErrorNO_WRITE_PERMISSIONThe user does not have permissions to change the lock state or access the file.static LockFileErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static LockFileErrorTOO_MANY_FILESThere are too many files in one request.static LockFileErrorTOO_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 booleanequals(java.lang.Object obj)LockConflictErrorgetLockConflictValue()The user action conflicts with an existing lock on the file.LookupErrorgetPathLookupValue()Could not find the specified resource.inthashCode()booleanisCannotBeLocked()booleanisFileNotShared()booleanisInternalError()booleanisLockConflict()booleanisNoWritePermission()booleanisOther()booleanisPathLookup()booleanisTooManyFiles()booleanisTooManyWriteOperations()Returnstrueif this instance has the tagLockFileError.Tag.TOO_MANY_WRITE_OPERATIONS,falseotherwise.static LockFileErrorlockConflict(LockConflictError value)Returns an instance ofLockFileErrorthat has its tag set toLockFileError.Tag.LOCK_CONFLICT.static LockFileErrorpathLookup(LookupError value)Returns an instance ofLockFileErrorthat has its tag set toLockFileError.Tag.PATH_LOOKUP.LockFileError.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- 
TOO_MANY_WRITE_OPERATIONSpublic static final LockFileError TOO_MANY_WRITE_OPERATIONS There are too many write operations in user's Dropbox. Please retry this request.
 - 
TOO_MANY_FILESpublic static final LockFileError TOO_MANY_FILES There are too many files in one request. Please retry with fewer files.
 - 
NO_WRITE_PERMISSIONpublic static final LockFileError NO_WRITE_PERMISSION The user does not have permissions to change the lock state or access the file.
 - 
CANNOT_BE_LOCKEDpublic static final LockFileError CANNOT_BE_LOCKED Item is a type that cannot be locked.
 - 
FILE_NOT_SHAREDpublic static final LockFileError FILE_NOT_SHARED Requested file is not currently shared.
 - 
INTERNAL_ERRORpublic static final LockFileError INTERNAL_ERROR Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.
 - 
OTHERpublic static final LockFileError 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 LockFileError.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 thisLockFileError.If a tag returned by the server is unrecognized by this SDK, the LockFileError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
 
 - 
isPathLookuppublic boolean isPathLookup() - Returns:
- trueif this instance is tagged as- LockFileError.Tag.PATH_LOOKUP,- falseotherwise.
 
 - 
pathLookuppublic static LockFileError pathLookup(LookupError value) Returns an instance ofLockFileErrorthat has its tag set toLockFileError.Tag.PATH_LOOKUP.Could not find the specified resource. - Parameters:
- value- value to assign to this instance.
- Returns:
- Instance of LockFileErrorwith its tag set toLockFileError.Tag.PATH_LOOKUP.
- Throws:
- java.lang.IllegalArgumentException- if- valueis- null.
 
 - 
getPathLookupValuepublic LookupError getPathLookupValue() Could not find the specified resource.This instance must be tagged as LockFileError.Tag.PATH_LOOKUP.- Returns:
- The LookupErrorvalue associated with this instance ifisPathLookup()istrue.
- Throws:
- java.lang.IllegalStateException- If- isPathLookup()is- false.
 
 - 
isTooManyWriteOperationspublic boolean isTooManyWriteOperations() Returnstrueif this instance has the tagLockFileError.Tag.TOO_MANY_WRITE_OPERATIONS,falseotherwise.- Returns:
- trueif this instance is tagged as- LockFileError.Tag.TOO_MANY_WRITE_OPERATIONS,- falseotherwise.
 
 - 
isTooManyFilespublic boolean isTooManyFiles() - Returns:
- trueif this instance is tagged as- LockFileError.Tag.TOO_MANY_FILES,- falseotherwise.
 
 - 
isNoWritePermissionpublic boolean isNoWritePermission() - Returns:
- trueif this instance is tagged as- LockFileError.Tag.NO_WRITE_PERMISSION,- falseotherwise.
 
 - 
isCannotBeLockedpublic boolean isCannotBeLocked() - Returns:
- trueif this instance is tagged as- LockFileError.Tag.CANNOT_BE_LOCKED,- falseotherwise.
 
 - 
isFileNotSharedpublic boolean isFileNotShared() - Returns:
- trueif this instance is tagged as- LockFileError.Tag.FILE_NOT_SHARED,- falseotherwise.
 
 - 
isLockConflictpublic boolean isLockConflict() - Returns:
- trueif this instance is tagged as- LockFileError.Tag.LOCK_CONFLICT,- falseotherwise.
 
 - 
lockConflictpublic static LockFileError lockConflict(LockConflictError value) Returns an instance ofLockFileErrorthat has its tag set toLockFileError.Tag.LOCK_CONFLICT.The user action conflicts with an existing lock on the file. - Parameters:
- value- value to assign to this instance.
- Returns:
- Instance of LockFileErrorwith its tag set toLockFileError.Tag.LOCK_CONFLICT.
- Throws:
- java.lang.IllegalArgumentException- if- valueis- null.
 
 - 
getLockConflictValuepublic LockConflictError getLockConflictValue() The user action conflicts with an existing lock on the file.This instance must be tagged as LockFileError.Tag.LOCK_CONFLICT.- Returns:
- The LockConflictErrorvalue associated with this instance ifisLockConflict()istrue.
- Throws:
- java.lang.IllegalStateException- If- isLockConflict()is- false.
 
 - 
isInternalErrorpublic boolean isInternalError() - Returns:
- trueif this instance is tagged as- LockFileError.Tag.INTERNAL_ERROR,- falseotherwise.
 
 - 
isOtherpublic boolean isOther() - Returns:
- trueif this instance is tagged as- LockFileError.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
 
 
- 
 
-