Package com.dropbox.core.v2.files

Class WriteError

java.lang.Object

com.dropbox.core.v2.files.WriteError

public final class WriteError
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	WriteError.Tag	Discriminating tag type for WriteError.

Field Summary

Fields

Modifier and Type	Field	Description
static final WriteError	ACCESS_RESTRICTED	The user doesn't have permission to perform the action due to restrictions set by a team administrator
static final WriteError	DISALLOWED_NAME	Dropbox will not save the file or folder because of its name.
static final WriteError	INSUFFICIENT_SPACE	The user doesn't have enough available space (bytes) to write more data.
static final WriteError	NO_WRITE_PERMISSION	The user doesn't have permissions to write to the target location.
static final WriteError	OPERATION_SUPPRESSED	This file operation is not allowed at this path.
static final WriteError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final WriteError	TEAM_FOLDER	This endpoint cannot move or delete team folders.
static final WriteError	TOO_MANY_WRITE_OPERATIONS	There are too many write operations in user's Dropbox.

Method Summary

Modifier and Type	Method	Description
static WriteError	conflict(WriteConflictError value)	Returns an instance of WriteError that has its tag set to WriteError.Tag.CONFLICT.
boolean	equals(Object obj)
WriteConflictError	getConflictValue()	Couldn't write to the target path because there was something in the way.
String	getMalformedPathValue()	The given path does not satisfy the required path format.
int	hashCode()
boolean	isAccessRestricted()	Returns true if this instance has the tag WriteError.Tag.ACCESS_RESTRICTED, false otherwise.
boolean	isConflict()	Returns true if this instance has the tag WriteError.Tag.CONFLICT, false otherwise.
boolean	isDisallowedName()	Returns true if this instance has the tag WriteError.Tag.DISALLOWED_NAME, false otherwise.
boolean	isInsufficientSpace()	Returns true if this instance has the tag WriteError.Tag.INSUFFICIENT_SPACE, false otherwise.
boolean	isMalformedPath()	Returns true if this instance has the tag WriteError.Tag.MALFORMED_PATH, false otherwise.
boolean	isNoWritePermission()	Returns true if this instance has the tag WriteError.Tag.NO_WRITE_PERMISSION, false otherwise.
boolean	isOperationSuppressed()	Returns true if this instance has the tag WriteError.Tag.OPERATION_SUPPRESSED, false otherwise.
boolean	isOther()	Returns true if this instance has the tag WriteError.Tag.OTHER, false otherwise.
boolean	isTeamFolder()	Returns true if this instance has the tag WriteError.Tag.TEAM_FOLDER, false otherwise.
boolean	isTooManyWriteOperations()	Returns true if this instance has the tag WriteError.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.
static WriteError	malformedPath()	Returns an instance of WriteError that has its tag set to WriteError.Tag.MALFORMED_PATH.
static WriteError	malformedPath(String value)	Returns an instance of WriteError that has its tag set to WriteError.Tag.MALFORMED_PATH.
WriteError.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

NO_WRITE_PERMISSION

public static final WriteError NO_WRITE_PERMISSION

The user doesn't have permissions to write to the target location.

INSUFFICIENT_SPACE

public static final WriteError INSUFFICIENT_SPACE

The user doesn't have enough available space (bytes) to write more data.

DISALLOWED_NAME

public static final WriteError DISALLOWED_NAME

Dropbox will not save the file or folder because of its name.

TEAM_FOLDER

public static final WriteError TEAM_FOLDER

This endpoint cannot move or delete team folders.

OPERATION_SUPPRESSED

public static final WriteError OPERATION_SUPPRESSED

This file operation is not allowed at this path.

TOO_MANY_WRITE_OPERATIONS

public static final WriteError TOO_MANY_WRITE_OPERATIONS

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

ACCESS_RESTRICTED

public static final WriteError ACCESS_RESTRICTED

The user doesn't have permission to perform the action due to restrictions set by a team administrator

OTHER

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

If a tag returned by the server is unrecognized by this SDK, the WriteError.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isMalformedPath

public boolean isMalformedPath()

Returns true if this instance has the tag WriteError.Tag.MALFORMED_PATH, false otherwise.

Returns:

true if this instance is tagged as WriteError.Tag.MALFORMED_PATH, false otherwise.

malformedPath

public static WriteError malformedPath(String value)

Returns an instance of WriteError that has its tag set to WriteError.Tag.MALFORMED_PATH.

The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.

Parameters:

value - value to assign to this instance.

Returns:

Instance of WriteError with its tag set to WriteError.Tag.MALFORMED_PATH.

malformedPath

public static WriteError malformedPath()

Returns an instance of WriteError that has its tag set to WriteError.Tag.MALFORMED_PATH.

The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.

Returns:

Instance of WriteError with its tag set to WriteError.Tag.MALFORMED_PATH.

getMalformedPathValue

public String getMalformedPathValue()

The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.

This instance must be tagged as WriteError.Tag.MALFORMED_PATH.

Returns:

The String value associated with this instance if isMalformedPath() is true.

Throws:

IllegalStateException - If isMalformedPath() is false.

isConflict

public boolean isConflict()

Returns true if this instance has the tag WriteError.Tag.CONFLICT, false otherwise.

Returns:

true if this instance is tagged as WriteError.Tag.CONFLICT, false otherwise.

conflict

public static WriteError conflict(WriteConflictError value)

Returns an instance of WriteError that has its tag set to WriteError.Tag.CONFLICT.

Couldn't write to the target path because there was something in the way.

Parameters:

value - value to assign to this instance.

Returns:

Instance of WriteError with its tag set to WriteError.Tag.CONFLICT.

Throws:

IllegalArgumentException - if value is null.

getConflictValue

public WriteConflictError getConflictValue()

Couldn't write to the target path because there was something in the way.

This instance must be tagged as WriteError.Tag.CONFLICT.

Returns:

The WriteConflictError value associated with this instance if isConflict() is true.

Throws:

IllegalStateException - If isConflict() is false.

isNoWritePermission

public boolean isNoWritePermission()

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

Returns:

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

isInsufficientSpace

public boolean isInsufficientSpace()

Returns true if this instance has the tag WriteError.Tag.INSUFFICIENT_SPACE, false otherwise.

Returns:

true if this instance is tagged as WriteError.Tag.INSUFFICIENT_SPACE, false otherwise.

isDisallowedName

public boolean isDisallowedName()

Returns true if this instance has the tag WriteError.Tag.DISALLOWED_NAME, false otherwise.

Returns:

true if this instance is tagged as WriteError.Tag.DISALLOWED_NAME, false otherwise.

isTeamFolder

public boolean isTeamFolder()

Returns true if this instance has the tag WriteError.Tag.TEAM_FOLDER, false otherwise.

Returns:

true if this instance is tagged as WriteError.Tag.TEAM_FOLDER, false otherwise.

isOperationSuppressed

public boolean isOperationSuppressed()

Returns true if this instance has the tag WriteError.Tag.OPERATION_SUPPRESSED, false otherwise.

Returns:

true if this instance is tagged as WriteError.Tag.OPERATION_SUPPRESSED, false otherwise.

isTooManyWriteOperations

public boolean isTooManyWriteOperations()

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

Returns:

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

isAccessRestricted

public boolean isAccessRestricted()

Returns true if this instance has the tag WriteError.Tag.ACCESS_RESTRICTED, false otherwise.

Returns:

true if this instance is tagged as WriteError.Tag.ACCESS_RESTRICTED, false otherwise.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as WriteError.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