Package com.dropbox.core.v2.files

Class RelocationBatchError

java.lang.Object

com.dropbox.core.v2.files.RelocationBatchError

public final class RelocationBatchError
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RelocationBatchError.Tag	Discriminating tag type for RelocationBatchError.

Field Summary

Fields

Modifier and Type	Field	Description
static final RelocationBatchError	CANT_COPY_SHARED_FOLDER	Shared folders can't be copied.
static final RelocationBatchError	CANT_MOVE_FOLDER_INTO_ITSELF	You cannot move a folder into itself.
static final RelocationBatchError	CANT_MOVE_SHARED_FOLDER	Can't move the shared folder to the given destination.
static final RelocationBatchError	CANT_NEST_SHARED_FOLDER	Your move operation would result in nested shared folders.
static final RelocationBatchError	CANT_TRANSFER_OWNERSHIP	Your move operation would result in an ownership transfer.
static final RelocationBatchError	DUPLICATED_OR_NESTED_PATHS	There are duplicated/nested paths among RelocationPath.getFromPath() and RelocationPath.getToPath().
static final RelocationBatchError	INSUFFICIENT_QUOTA	The current user does not have enough space to move or copy the files.
static final RelocationBatchError	INTERNAL_ERROR	Something went wrong with the job on Dropbox's end.
static final RelocationBatchError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final RelocationBatchError	TOO_MANY_FILES	The operation would involve more than 10,000 files and folders.
static final RelocationBatchError	TOO_MANY_WRITE_OPERATIONS	There are too many write operations in user's Dropbox.

Method Summary

Modifier and Type	Method	Description
static RelocationBatchError	cantMoveIntoFamily(MoveIntoFamilyError value)	Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.CANT_MOVE_INTO_FAMILY.
static RelocationBatchError	cantMoveIntoVault(MoveIntoVaultError value)	Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.CANT_MOVE_INTO_VAULT.
boolean	equals(Object obj)
static RelocationBatchError	fromLookup(LookupError value)	Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.FROM_LOOKUP.
static RelocationBatchError	fromWrite(WriteError value)	Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.FROM_WRITE.
MoveIntoFamilyError	getCantMoveIntoFamilyValue()	Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.
MoveIntoVaultError	getCantMoveIntoVaultValue()	Some content cannot be moved into Vault under certain circumstances, see detailed error.
LookupError	getFromLookupValue()	This instance must be tagged as RelocationBatchError.Tag.FROM_LOOKUP.
WriteError	getFromWriteValue()	This instance must be tagged as RelocationBatchError.Tag.FROM_WRITE.
WriteError	getToValue()	This instance must be tagged as RelocationBatchError.Tag.TO.
int	hashCode()
boolean	isCantCopySharedFolder()	Returns true if this instance has the tag RelocationBatchError.Tag.CANT_COPY_SHARED_FOLDER, false otherwise.
boolean	isCantMoveFolderIntoItself()	Returns true if this instance has the tag RelocationBatchError.Tag.CANT_MOVE_FOLDER_INTO_ITSELF, false otherwise.
boolean	isCantMoveIntoFamily()	Returns true if this instance has the tag RelocationBatchError.Tag.CANT_MOVE_INTO_FAMILY, false otherwise.
boolean	isCantMoveIntoVault()	Returns true if this instance has the tag RelocationBatchError.Tag.CANT_MOVE_INTO_VAULT, false otherwise.
boolean	isCantMoveSharedFolder()	Returns true if this instance has the tag RelocationBatchError.Tag.CANT_MOVE_SHARED_FOLDER, false otherwise.
boolean	isCantNestSharedFolder()	Returns true if this instance has the tag RelocationBatchError.Tag.CANT_NEST_SHARED_FOLDER, false otherwise.
boolean	isCantTransferOwnership()	Returns true if this instance has the tag RelocationBatchError.Tag.CANT_TRANSFER_OWNERSHIP, false otherwise.
boolean	isDuplicatedOrNestedPaths()	Returns true if this instance has the tag RelocationBatchError.Tag.DUPLICATED_OR_NESTED_PATHS, false otherwise.
boolean	isFromLookup()	Returns true if this instance has the tag RelocationBatchError.Tag.FROM_LOOKUP, false otherwise.
boolean	isFromWrite()	Returns true if this instance has the tag RelocationBatchError.Tag.FROM_WRITE, false otherwise.
boolean	isInsufficientQuota()	Returns true if this instance has the tag RelocationBatchError.Tag.INSUFFICIENT_QUOTA, false otherwise.
boolean	isInternalError()	Returns true if this instance has the tag RelocationBatchError.Tag.INTERNAL_ERROR, false otherwise.
boolean	isOther()	Returns true if this instance has the tag RelocationBatchError.Tag.OTHER, false otherwise.
boolean	isTo()	Returns true if this instance has the tag RelocationBatchError.Tag.TO, false otherwise.
boolean	isTooManyFiles()	Returns true if this instance has the tag RelocationBatchError.Tag.TOO_MANY_FILES, false otherwise.
boolean	isTooManyWriteOperations()	Returns true if this instance has the tag RelocationBatchError.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.
RelocationBatchError.Tag	tag()	Returns the tag for this instance.
static RelocationBatchError	to(WriteError value)	Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.TO.
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

CANT_COPY_SHARED_FOLDER

public static final RelocationBatchError CANT_COPY_SHARED_FOLDER

Shared folders can't be copied.

CANT_NEST_SHARED_FOLDER

public static final RelocationBatchError CANT_NEST_SHARED_FOLDER

Your move operation would result in nested shared folders. This is not allowed.

CANT_MOVE_FOLDER_INTO_ITSELF

public static final RelocationBatchError CANT_MOVE_FOLDER_INTO_ITSELF

You cannot move a folder into itself.

TOO_MANY_FILES

public static final RelocationBatchError TOO_MANY_FILES

The operation would involve more than 10,000 files and folders.

DUPLICATED_OR_NESTED_PATHS

public static final RelocationBatchError DUPLICATED_OR_NESTED_PATHS

There are duplicated/nested paths among RelocationPath.getFromPath() and RelocationPath.getToPath().

CANT_TRANSFER_OWNERSHIP

public static final RelocationBatchError CANT_TRANSFER_OWNERSHIP

Your move operation would result in an ownership transfer. You may reissue the request with the field RelocationArg.getAllowOwnershipTransfer() to true.

INSUFFICIENT_QUOTA

public static final RelocationBatchError INSUFFICIENT_QUOTA

The current user does not have enough space to move or copy the files.

INTERNAL_ERROR

public static final RelocationBatchError 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.

CANT_MOVE_SHARED_FOLDER

public static final RelocationBatchError CANT_MOVE_SHARED_FOLDER

Can't move the shared folder to the given destination.

OTHER

public static final RelocationBatchError 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.

TOO_MANY_WRITE_OPERATIONS

public static final RelocationBatchError TOO_MANY_WRITE_OPERATIONS

There are too many write operations in user's Dropbox. Please retry this request.

Method Details

tag

public RelocationBatchError.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 RelocationBatchError.

Returns:

the tag for this instance.

isFromLookup

public boolean isFromLookup()

Returns true if this instance has the tag RelocationBatchError.Tag.FROM_LOOKUP, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.FROM_LOOKUP, false otherwise.

fromLookup

public static RelocationBatchError fromLookup(LookupError value)

Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.FROM_LOOKUP.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchError with its tag set to RelocationBatchError.Tag.FROM_LOOKUP.

Throws:

IllegalArgumentException - if value is null.

getFromLookupValue

public LookupError getFromLookupValue()

This instance must be tagged as RelocationBatchError.Tag.FROM_LOOKUP.

Returns:

The LookupError value associated with this instance if isFromLookup() is true.

Throws:

IllegalStateException - If isFromLookup() is false.

isFromWrite

public boolean isFromWrite()

Returns true if this instance has the tag RelocationBatchError.Tag.FROM_WRITE, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.FROM_WRITE, false otherwise.

fromWrite

public static RelocationBatchError fromWrite(WriteError value)

Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.FROM_WRITE.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchError with its tag set to RelocationBatchError.Tag.FROM_WRITE.

Throws:

IllegalArgumentException - if value is null.

getFromWriteValue

public WriteError getFromWriteValue()

This instance must be tagged as RelocationBatchError.Tag.FROM_WRITE.

Returns:

The WriteError value associated with this instance if isFromWrite() is true.

Throws:

IllegalStateException - If isFromWrite() is false.

isTo

public boolean isTo()

Returns true if this instance has the tag RelocationBatchError.Tag.TO, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.TO, false otherwise.

to

public static RelocationBatchError to(WriteError value)

Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.TO.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchError with its tag set to RelocationBatchError.Tag.TO.

Throws:

IllegalArgumentException - if value is null.

getToValue

public WriteError getToValue()

This instance must be tagged as RelocationBatchError.Tag.TO.

Returns:

The WriteError value associated with this instance if isTo() is true.

Throws:

IllegalStateException - If isTo() is false.

isCantCopySharedFolder

public boolean isCantCopySharedFolder()

Returns true if this instance has the tag RelocationBatchError.Tag.CANT_COPY_SHARED_FOLDER, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.CANT_COPY_SHARED_FOLDER, false otherwise.

isCantNestSharedFolder

public boolean isCantNestSharedFolder()

Returns true if this instance has the tag RelocationBatchError.Tag.CANT_NEST_SHARED_FOLDER, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.CANT_NEST_SHARED_FOLDER, false otherwise.

isCantMoveFolderIntoItself

public boolean isCantMoveFolderIntoItself()

Returns true if this instance has the tag RelocationBatchError.Tag.CANT_MOVE_FOLDER_INTO_ITSELF, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.CANT_MOVE_FOLDER_INTO_ITSELF, false otherwise.

isTooManyFiles

public boolean isTooManyFiles()

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

Returns:

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

isDuplicatedOrNestedPaths

public boolean isDuplicatedOrNestedPaths()

Returns true if this instance has the tag RelocationBatchError.Tag.DUPLICATED_OR_NESTED_PATHS, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.DUPLICATED_OR_NESTED_PATHS, false otherwise.

isCantTransferOwnership

public boolean isCantTransferOwnership()

Returns true if this instance has the tag RelocationBatchError.Tag.CANT_TRANSFER_OWNERSHIP, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.CANT_TRANSFER_OWNERSHIP, false otherwise.

isInsufficientQuota

public boolean isInsufficientQuota()

Returns true if this instance has the tag RelocationBatchError.Tag.INSUFFICIENT_QUOTA, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.INSUFFICIENT_QUOTA, false otherwise.

isInternalError

public boolean isInternalError()

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

Returns:

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

isCantMoveSharedFolder

public boolean isCantMoveSharedFolder()

Returns true if this instance has the tag RelocationBatchError.Tag.CANT_MOVE_SHARED_FOLDER, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.CANT_MOVE_SHARED_FOLDER, false otherwise.

isCantMoveIntoVault

public boolean isCantMoveIntoVault()

Returns true if this instance has the tag RelocationBatchError.Tag.CANT_MOVE_INTO_VAULT, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.CANT_MOVE_INTO_VAULT, false otherwise.

cantMoveIntoVault

public static RelocationBatchError cantMoveIntoVault(MoveIntoVaultError value)

Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.CANT_MOVE_INTO_VAULT.

Some content cannot be moved into Vault under certain circumstances, see detailed error.

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchError with its tag set to RelocationBatchError.Tag.CANT_MOVE_INTO_VAULT.

Throws:

IllegalArgumentException - if value is null.

getCantMoveIntoVaultValue

public MoveIntoVaultError getCantMoveIntoVaultValue()

Some content cannot be moved into Vault under certain circumstances, see detailed error.

This instance must be tagged as RelocationBatchError.Tag.CANT_MOVE_INTO_VAULT.

Returns:

The MoveIntoVaultError value associated with this instance if isCantMoveIntoVault() is true.

Throws:

IllegalStateException - If isCantMoveIntoVault() is false.

isCantMoveIntoFamily

public boolean isCantMoveIntoFamily()

Returns true if this instance has the tag RelocationBatchError.Tag.CANT_MOVE_INTO_FAMILY, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchError.Tag.CANT_MOVE_INTO_FAMILY, false otherwise.

cantMoveIntoFamily

public static RelocationBatchError cantMoveIntoFamily(MoveIntoFamilyError value)

Returns an instance of RelocationBatchError that has its tag set to RelocationBatchError.Tag.CANT_MOVE_INTO_FAMILY.

Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchError with its tag set to RelocationBatchError.Tag.CANT_MOVE_INTO_FAMILY.

Throws:

IllegalArgumentException - if value is null.

getCantMoveIntoFamilyValue

public MoveIntoFamilyError getCantMoveIntoFamilyValue()

Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.

This instance must be tagged as RelocationBatchError.Tag.CANT_MOVE_INTO_FAMILY.

Returns:

The MoveIntoFamilyError value associated with this instance if isCantMoveIntoFamily() is true.

Throws:

IllegalStateException - If isCantMoveIntoFamily() is false.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as RelocationBatchError.Tag.OTHER, false otherwise.

isTooManyWriteOperations

public boolean isTooManyWriteOperations()

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

Returns:

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