Package com.dropbox.core.v2.files

Class LockFileError

java.lang.Object

com.dropbox.core.v2.files.LockFileError

public final class LockFileError
extends Object

This class is an open 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.

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 enum	LockFileError.Tag	Discriminating tag type for LockFileError.

Field Summary

Fields

Modifier and Type	Field	Description
static final LockFileError	CANNOT_BE_LOCKED	Item is a type that cannot be locked.
static final LockFileError	FILE_NOT_SHARED	Requested file is not currently shared.
static final LockFileError	INTERNAL_ERROR	Something went wrong with the job on Dropbox's end.
static final LockFileError	NO_WRITE_PERMISSION	The user does not have permissions to change the lock state or access the file.
static final LockFileError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final LockFileError	TOO_MANY_FILES	There are too many files in one request.
static final LockFileError	TOO_MANY_WRITE_OPERATIONS	There are too many write operations in user's Dropbox.

Method Summary

Modifier and Type	Method	Description
boolean	equals(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()	Returns true if this instance has the tag LockFileError.Tag.CANNOT_BE_LOCKED, false otherwise.
boolean	isFileNotShared()	Returns true if this instance has the tag LockFileError.Tag.FILE_NOT_SHARED, false otherwise.
boolean	isInternalError()	Returns true if this instance has the tag LockFileError.Tag.INTERNAL_ERROR, false otherwise.
boolean	isLockConflict()	Returns true if this instance has the tag LockFileError.Tag.LOCK_CONFLICT, false otherwise.
boolean	isNoWritePermission()	Returns true if this instance has the tag LockFileError.Tag.NO_WRITE_PERMISSION, false otherwise.
boolean	isOther()	Returns true if this instance has the tag LockFileError.Tag.OTHER, false otherwise.
boolean	isPathLookup()	Returns true if this instance has the tag LockFileError.Tag.PATH_LOOKUP, false otherwise.
boolean	isTooManyFiles()	Returns true if this instance has the tag LockFileError.Tag.TOO_MANY_FILES, false otherwise.
boolean	isTooManyWriteOperations()	Returns true if this instance has the tag LockFileError.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.
static LockFileError	lockConflict(LockConflictError value)	Returns an instance of LockFileError that has its tag set to LockFileError.Tag.LOCK_CONFLICT.
static LockFileError	pathLookup(LookupError value)	Returns an instance of LockFileError that has its tag set to LockFileError.Tag.PATH_LOOKUP.
LockFileError.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

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 Details

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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this LockFileError.

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 has the tag LockFileError.Tag.PATH_LOOKUP, false otherwise.

Returns:

true if this instance is tagged as LockFileError.Tag.PATH_LOOKUP, false otherwise.

pathLookup

public static LockFileError pathLookup(LookupError value)

Returns an instance of LockFileError that has its tag set to LockFileError.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 to LockFileError.Tag.PATH_LOOKUP.

Throws:

IllegalArgumentException - if value is null.

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 if isPathLookup() is true.

Throws:

IllegalStateException - If isPathLookup() is false.

isTooManyWriteOperations

public boolean isTooManyWriteOperations()

Returns true if this instance has the tag LockFileError.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.

Returns:

true if this instance is tagged as LockFileError.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.

isTooManyFiles

public boolean isTooManyFiles()

Returns true if this instance has the tag LockFileError.Tag.TOO_MANY_FILES, false otherwise.

Returns:

true if this instance is tagged as LockFileError.Tag.TOO_MANY_FILES, false otherwise.

isNoWritePermission

public boolean isNoWritePermission()

Returns true if this instance has the tag LockFileError.Tag.NO_WRITE_PERMISSION, false otherwise.

Returns:

true if this instance is tagged as LockFileError.Tag.NO_WRITE_PERMISSION, false otherwise.

isCannotBeLocked

public boolean isCannotBeLocked()

Returns true if this instance has the tag LockFileError.Tag.CANNOT_BE_LOCKED, false otherwise.

Returns:

true if this instance is tagged as LockFileError.Tag.CANNOT_BE_LOCKED, false otherwise.

isFileNotShared

public boolean isFileNotShared()

Returns true if this instance has the tag LockFileError.Tag.FILE_NOT_SHARED, false otherwise.

Returns:

true if this instance is tagged as LockFileError.Tag.FILE_NOT_SHARED, false otherwise.

isLockConflict

public boolean isLockConflict()

Returns true if this instance has the tag LockFileError.Tag.LOCK_CONFLICT, false otherwise.

Returns:

true if this instance is tagged as LockFileError.Tag.LOCK_CONFLICT, false otherwise.

lockConflict

public static LockFileError lockConflict(LockConflictError value)

Returns an instance of LockFileError that has its tag set to LockFileError.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 to LockFileError.Tag.LOCK_CONFLICT.

Throws:

IllegalArgumentException - if value is null.

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 if isLockConflict() is true.

Throws:

IllegalStateException - If isLockConflict() is false.

isInternalError

public boolean isInternalError()

Returns true if this instance has the tag LockFileError.Tag.INTERNAL_ERROR, false otherwise.

Returns:

true if this instance is tagged as LockFileError.Tag.INTERNAL_ERROR, false otherwise.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as LockFileError.Tag.OTHER, 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