Class LockFileError
- java.lang.Object
-
- com.dropbox.core.v2.files.LockFileError
-
public final class LockFileError 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 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
OTHER
value will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LockFileError.Tag
Discriminating tag type forLockFileError
.
-
Field Summary
Fields Modifier and Type Field Description static LockFileError
CANNOT_BE_LOCKED
Item is a type that cannot be locked.static LockFileError
FILE_NOT_SHARED
Requested file is not currently shared.static LockFileError
INTERNAL_ERROR
Something went wrong with the job on Dropbox's end.static LockFileError
NO_WRITE_PERMISSION
The user does not have permissions to change the lock state or access the file.static LockFileError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static LockFileError
TOO_MANY_FILES
There are too many files in one request.static LockFileError
TOO_MANY_WRITE_OPERATIONS
There are too many write operations in user's Dropbox.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
LockConflictError
getLockConflictValue()
The user action conflicts with an existing lock on the file.LookupError
getPathLookupValue()
Could not find the specified resource.int
hashCode()
boolean
isCannotBeLocked()
boolean
isFileNotShared()
boolean
isInternalError()
boolean
isLockConflict()
boolean
isNoWritePermission()
boolean
isOther()
boolean
isPathLookup()
boolean
isTooManyFiles()
boolean
isTooManyWriteOperations()
Returnstrue
if this instance has the tagLockFileError.Tag.TOO_MANY_WRITE_OPERATIONS
,false
otherwise.static LockFileError
lockConflict(LockConflictError value)
Returns an instance ofLockFileError
that has its tag set toLockFileError.Tag.LOCK_CONFLICT
.static LockFileError
pathLookup(LookupError value)
Returns an instance ofLockFileError
that has its tag set toLockFileError.Tag.PATH_LOOKUP
.LockFileError.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
-
TOO_MANY_WRITE_OPERATIONS
public static final LockFileError TOO_MANY_WRITE_OPERATIONS
There are too many write operations in user's Dropbox. Please retry this request.
-
TOO_MANY_FILES
public static final LockFileError TOO_MANY_FILES
There are too many files in one request. Please retry with fewer files.
-
NO_WRITE_PERMISSION
public static final LockFileError NO_WRITE_PERMISSION
The user does not have permissions to change the lock state or access the file.
-
CANNOT_BE_LOCKED
public static final LockFileError CANNOT_BE_LOCKED
Item is a type that cannot be locked.
-
FILE_NOT_SHARED
public static final LockFileError FILE_NOT_SHARED
Requested file is not currently shared.
-
INTERNAL_ERROR
public 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.
-
OTHER
public 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
-
tag
public 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 aswitch
statement to properly handle the different values for thisLockFileError
.If a tag returned by the server is unrecognized by this SDK, the
LockFileError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isPathLookup
public boolean isPathLookup()
- Returns:
true
if this instance is tagged asLockFileError.Tag.PATH_LOOKUP
,false
otherwise.
-
pathLookup
public static LockFileError pathLookup(LookupError value)
Returns an instance ofLockFileError
that 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
LockFileError
with its tag set toLockFileError.Tag.PATH_LOOKUP
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getPathLookupValue
public LookupError getPathLookupValue()
Could not find the specified resource.This instance must be tagged as
LockFileError.Tag.PATH_LOOKUP
.- Returns:
- The
LookupError
value associated with this instance ifisPathLookup()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPathLookup()
isfalse
.
-
isTooManyWriteOperations
public boolean isTooManyWriteOperations()
Returnstrue
if this instance has the tagLockFileError.Tag.TOO_MANY_WRITE_OPERATIONS
,false
otherwise.- Returns:
true
if this instance is tagged asLockFileError.Tag.TOO_MANY_WRITE_OPERATIONS
,false
otherwise.
-
isTooManyFiles
public boolean isTooManyFiles()
- Returns:
true
if this instance is tagged asLockFileError.Tag.TOO_MANY_FILES
,false
otherwise.
-
isNoWritePermission
public boolean isNoWritePermission()
- Returns:
true
if this instance is tagged asLockFileError.Tag.NO_WRITE_PERMISSION
,false
otherwise.
-
isCannotBeLocked
public boolean isCannotBeLocked()
- Returns:
true
if this instance is tagged asLockFileError.Tag.CANNOT_BE_LOCKED
,false
otherwise.
-
isFileNotShared
public boolean isFileNotShared()
- Returns:
true
if this instance is tagged asLockFileError.Tag.FILE_NOT_SHARED
,false
otherwise.
-
isLockConflict
public boolean isLockConflict()
- Returns:
true
if this instance is tagged asLockFileError.Tag.LOCK_CONFLICT
,false
otherwise.
-
lockConflict
public static LockFileError lockConflict(LockConflictError value)
Returns an instance ofLockFileError
that 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
LockFileError
with its tag set toLockFileError.Tag.LOCK_CONFLICT
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getLockConflictValue
public 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
LockConflictError
value associated with this instance ifisLockConflict()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisLockConflict()
isfalse
.
-
isInternalError
public boolean isInternalError()
- Returns:
true
if this instance is tagged asLockFileError.Tag.INTERNAL_ERROR
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asLockFileError.Tag.OTHER
,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
-
-