Class RelocationError
- java.lang.Object
-
- com.dropbox.core.v2.files.RelocationError
-
public final class RelocationError 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 Summary
Nested Classes Modifier and Type Class Description static classRelocationError.TagDiscriminating tag type forRelocationError.
-
Field Summary
Fields Modifier and Type Field Description static RelocationErrorCANT_COPY_SHARED_FOLDERShared folders can't be copied.static RelocationErrorCANT_MOVE_FOLDER_INTO_ITSELFYou cannot move a folder into itself.static RelocationErrorCANT_MOVE_SHARED_FOLDERCan't move the shared folder to the given destination.static RelocationErrorCANT_NEST_SHARED_FOLDERYour move operation would result in nested shared folders.static RelocationErrorCANT_TRANSFER_OWNERSHIPYour move operation would result in an ownership transfer.static RelocationErrorDUPLICATED_OR_NESTED_PATHSThere are duplicated/nested paths amongRelocationPath.getFromPath()andRelocationPath.getToPath().static RelocationErrorINSUFFICIENT_QUOTAThe current user does not have enough space to move or copy the files.static RelocationErrorINTERNAL_ERRORSomething went wrong with the job on Dropbox's end.static RelocationErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static RelocationErrorTOO_MANY_FILESThe operation would involve more than 10,000 files and folders.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RelocationErrorcantMoveIntoFamily(MoveIntoFamilyError value)Returns an instance ofRelocationErrorthat has its tag set toRelocationError.Tag.CANT_MOVE_INTO_FAMILY.static RelocationErrorcantMoveIntoVault(MoveIntoVaultError value)Returns an instance ofRelocationErrorthat has its tag set toRelocationError.Tag.CANT_MOVE_INTO_VAULT.booleanequals(java.lang.Object obj)static RelocationErrorfromLookup(LookupError value)Returns an instance ofRelocationErrorthat has its tag set toRelocationError.Tag.FROM_LOOKUP.static RelocationErrorfromWrite(WriteError value)Returns an instance ofRelocationErrorthat has its tag set toRelocationError.Tag.FROM_WRITE.MoveIntoFamilyErrorgetCantMoveIntoFamilyValue()Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.MoveIntoVaultErrorgetCantMoveIntoVaultValue()Some content cannot be moved into Vault under certain circumstances, see detailed error.LookupErrorgetFromLookupValue()This instance must be tagged asRelocationError.Tag.FROM_LOOKUP.WriteErrorgetFromWriteValue()This instance must be tagged asRelocationError.Tag.FROM_WRITE.WriteErrorgetToValue()This instance must be tagged asRelocationError.Tag.TO.inthashCode()booleanisCantCopySharedFolder()Returnstrueif this instance has the tagRelocationError.Tag.CANT_COPY_SHARED_FOLDER,falseotherwise.booleanisCantMoveFolderIntoItself()Returnstrueif this instance has the tagRelocationError.Tag.CANT_MOVE_FOLDER_INTO_ITSELF,falseotherwise.booleanisCantMoveIntoFamily()Returnstrueif this instance has the tagRelocationError.Tag.CANT_MOVE_INTO_FAMILY,falseotherwise.booleanisCantMoveIntoVault()Returnstrueif this instance has the tagRelocationError.Tag.CANT_MOVE_INTO_VAULT,falseotherwise.booleanisCantMoveSharedFolder()Returnstrueif this instance has the tagRelocationError.Tag.CANT_MOVE_SHARED_FOLDER,falseotherwise.booleanisCantNestSharedFolder()Returnstrueif this instance has the tagRelocationError.Tag.CANT_NEST_SHARED_FOLDER,falseotherwise.booleanisCantTransferOwnership()Returnstrueif this instance has the tagRelocationError.Tag.CANT_TRANSFER_OWNERSHIP,falseotherwise.booleanisDuplicatedOrNestedPaths()Returnstrueif this instance has the tagRelocationError.Tag.DUPLICATED_OR_NESTED_PATHS,falseotherwise.booleanisFromLookup()booleanisFromWrite()booleanisInsufficientQuota()booleanisInternalError()booleanisOther()booleanisTo()booleanisTooManyFiles()RelocationError.Tagtag()Returns the tag for this instance.static RelocationErrorto(WriteError value)Returns an instance ofRelocationErrorthat has its tag set toRelocationError.Tag.TO.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
CANT_COPY_SHARED_FOLDER
public static final RelocationError CANT_COPY_SHARED_FOLDER
Shared folders can't be copied.
-
CANT_NEST_SHARED_FOLDER
public static final RelocationError 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 RelocationError CANT_MOVE_FOLDER_INTO_ITSELF
You cannot move a folder into itself.
-
TOO_MANY_FILES
public static final RelocationError TOO_MANY_FILES
The operation would involve more than 10,000 files and folders.
-
DUPLICATED_OR_NESTED_PATHS
public static final RelocationError DUPLICATED_OR_NESTED_PATHS
There are duplicated/nested paths amongRelocationPath.getFromPath()andRelocationPath.getToPath().
-
CANT_TRANSFER_OWNERSHIP
public static final RelocationError CANT_TRANSFER_OWNERSHIP
Your move operation would result in an ownership transfer. You may reissue the request with the fieldRelocationArg.getAllowOwnershipTransfer()to true.
-
INSUFFICIENT_QUOTA
public static final RelocationError INSUFFICIENT_QUOTA
The current user does not have enough space to move or copy the files.
-
INTERNAL_ERROR
public static final RelocationError 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 RelocationError CANT_MOVE_SHARED_FOLDER
Can't move the shared folder to the given destination.
-
OTHER
public static final RelocationError 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 RelocationError.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 thisRelocationError.If a tag returned by the server is unrecognized by this SDK, the
RelocationError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isFromLookup
public boolean isFromLookup()
- Returns:
trueif this instance is tagged asRelocationError.Tag.FROM_LOOKUP,falseotherwise.
-
fromLookup
public static RelocationError fromLookup(LookupError value)
Returns an instance ofRelocationErrorthat has its tag set toRelocationError.Tag.FROM_LOOKUP.None
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
RelocationErrorwith its tag set toRelocationError.Tag.FROM_LOOKUP. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getFromLookupValue
public LookupError getFromLookupValue()
This instance must be tagged asRelocationError.Tag.FROM_LOOKUP.- Returns:
- The
LookupErrorvalue associated with this instance ifisFromLookup()istrue. - Throws:
java.lang.IllegalStateException- IfisFromLookup()isfalse.
-
isFromWrite
public boolean isFromWrite()
- Returns:
trueif this instance is tagged asRelocationError.Tag.FROM_WRITE,falseotherwise.
-
fromWrite
public static RelocationError fromWrite(WriteError value)
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
RelocationErrorwith its tag set toRelocationError.Tag.FROM_WRITE. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getFromWriteValue
public WriteError getFromWriteValue()
This instance must be tagged asRelocationError.Tag.FROM_WRITE.- Returns:
- The
WriteErrorvalue associated with this instance ifisFromWrite()istrue. - Throws:
java.lang.IllegalStateException- IfisFromWrite()isfalse.
-
isTo
public boolean isTo()
- Returns:
trueif this instance is tagged asRelocationError.Tag.TO,falseotherwise.
-
to
public static RelocationError to(WriteError value)
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
RelocationErrorwith its tag set toRelocationError.Tag.TO. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getToValue
public WriteError getToValue()
This instance must be tagged asRelocationError.Tag.TO.- Returns:
- The
WriteErrorvalue associated with this instance ifisTo()istrue. - Throws:
java.lang.IllegalStateException- IfisTo()isfalse.
-
isCantCopySharedFolder
public boolean isCantCopySharedFolder()
Returnstrueif this instance has the tagRelocationError.Tag.CANT_COPY_SHARED_FOLDER,falseotherwise.- Returns:
trueif this instance is tagged asRelocationError.Tag.CANT_COPY_SHARED_FOLDER,falseotherwise.
-
isCantNestSharedFolder
public boolean isCantNestSharedFolder()
Returnstrueif this instance has the tagRelocationError.Tag.CANT_NEST_SHARED_FOLDER,falseotherwise.- Returns:
trueif this instance is tagged asRelocationError.Tag.CANT_NEST_SHARED_FOLDER,falseotherwise.
-
isCantMoveFolderIntoItself
public boolean isCantMoveFolderIntoItself()
Returnstrueif this instance has the tagRelocationError.Tag.CANT_MOVE_FOLDER_INTO_ITSELF,falseotherwise.- Returns:
trueif this instance is tagged asRelocationError.Tag.CANT_MOVE_FOLDER_INTO_ITSELF,falseotherwise.
-
isTooManyFiles
public boolean isTooManyFiles()
- Returns:
trueif this instance is tagged asRelocationError.Tag.TOO_MANY_FILES,falseotherwise.
-
isDuplicatedOrNestedPaths
public boolean isDuplicatedOrNestedPaths()
Returnstrueif this instance has the tagRelocationError.Tag.DUPLICATED_OR_NESTED_PATHS,falseotherwise.- Returns:
trueif this instance is tagged asRelocationError.Tag.DUPLICATED_OR_NESTED_PATHS,falseotherwise.
-
isCantTransferOwnership
public boolean isCantTransferOwnership()
Returnstrueif this instance has the tagRelocationError.Tag.CANT_TRANSFER_OWNERSHIP,falseotherwise.- Returns:
trueif this instance is tagged asRelocationError.Tag.CANT_TRANSFER_OWNERSHIP,falseotherwise.
-
isInsufficientQuota
public boolean isInsufficientQuota()
- Returns:
trueif this instance is tagged asRelocationError.Tag.INSUFFICIENT_QUOTA,falseotherwise.
-
isInternalError
public boolean isInternalError()
- Returns:
trueif this instance is tagged asRelocationError.Tag.INTERNAL_ERROR,falseotherwise.
-
isCantMoveSharedFolder
public boolean isCantMoveSharedFolder()
Returnstrueif this instance has the tagRelocationError.Tag.CANT_MOVE_SHARED_FOLDER,falseotherwise.- Returns:
trueif this instance is tagged asRelocationError.Tag.CANT_MOVE_SHARED_FOLDER,falseotherwise.
-
isCantMoveIntoVault
public boolean isCantMoveIntoVault()
Returnstrueif this instance has the tagRelocationError.Tag.CANT_MOVE_INTO_VAULT,falseotherwise.- Returns:
trueif this instance is tagged asRelocationError.Tag.CANT_MOVE_INTO_VAULT,falseotherwise.
-
cantMoveIntoVault
public static RelocationError cantMoveIntoVault(MoveIntoVaultError value)
Returns an instance ofRelocationErrorthat has its tag set toRelocationError.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
RelocationErrorwith its tag set toRelocationError.Tag.CANT_MOVE_INTO_VAULT. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getCantMoveIntoVaultValue
public MoveIntoVaultError getCantMoveIntoVaultValue()
Some content cannot be moved into Vault under certain circumstances, see detailed error.This instance must be tagged as
RelocationError.Tag.CANT_MOVE_INTO_VAULT.- Returns:
- The
MoveIntoVaultErrorvalue associated with this instance ifisCantMoveIntoVault()istrue. - Throws:
java.lang.IllegalStateException- IfisCantMoveIntoVault()isfalse.
-
isCantMoveIntoFamily
public boolean isCantMoveIntoFamily()
Returnstrueif this instance has the tagRelocationError.Tag.CANT_MOVE_INTO_FAMILY,falseotherwise.- Returns:
trueif this instance is tagged asRelocationError.Tag.CANT_MOVE_INTO_FAMILY,falseotherwise.
-
cantMoveIntoFamily
public static RelocationError cantMoveIntoFamily(MoveIntoFamilyError value)
Returns an instance ofRelocationErrorthat has its tag set toRelocationError.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
RelocationErrorwith its tag set toRelocationError.Tag.CANT_MOVE_INTO_FAMILY. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
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
RelocationError.Tag.CANT_MOVE_INTO_FAMILY.- Returns:
- The
MoveIntoFamilyErrorvalue associated with this instance ifisCantMoveIntoFamily()istrue. - Throws:
java.lang.IllegalStateException- IfisCantMoveIntoFamily()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asRelocationError.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin 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
-
-