Package com.dropbox.core.v2.sharing

Class UpdateFilePolicyError

java.lang.Object

com.dropbox.core.v2.sharing.UpdateFilePolicyError

public final class UpdateFilePolicyError
extends Object

Error result for DbxUserSharingRequests.updateFilePolicy(String).

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

Field Summary

Fields

Modifier and Type	Field	Description
static final UpdateFilePolicyError	INVALID_FILE_SETTINGS	The file settings are invalid.
static final UpdateFilePolicyError	NO_PERMISSION	The current user does not have permission to perform this action.
static final UpdateFilePolicyError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static UpdateFilePolicyError	accessError(SharingFileAccessError value)	Returns an instance of UpdateFilePolicyError that has its tag set to UpdateFilePolicyError.Tag.ACCESS_ERROR.
boolean	equals(Object obj)
SharingFileAccessError	getAccessErrorValue()	This instance must be tagged as UpdateFilePolicyError.Tag.ACCESS_ERROR.
int	hashCode()
boolean	isAccessError()	Returns true if this instance has the tag UpdateFilePolicyError.Tag.ACCESS_ERROR, false otherwise.
boolean	isInvalidFileSettings()	Returns true if this instance has the tag UpdateFilePolicyError.Tag.INVALID_FILE_SETTINGS, false otherwise.
boolean	isNoPermission()	Returns true if this instance has the tag UpdateFilePolicyError.Tag.NO_PERMISSION, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UpdateFilePolicyError.Tag.OTHER, false otherwise.
UpdateFilePolicyError.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

INVALID_FILE_SETTINGS

public static final UpdateFilePolicyError INVALID_FILE_SETTINGS

The file settings are invalid.

NO_PERMISSION

public static final UpdateFilePolicyError NO_PERMISSION

The current user does not have permission to perform this action.

OTHER

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

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

Returns:

the tag for this instance.

isAccessError

public boolean isAccessError()

Returns true if this instance has the tag UpdateFilePolicyError.Tag.ACCESS_ERROR, false otherwise.

Returns:

true if this instance is tagged as UpdateFilePolicyError.Tag.ACCESS_ERROR, false otherwise.

accessError

public static UpdateFilePolicyError accessError(SharingFileAccessError value)

Returns an instance of UpdateFilePolicyError that has its tag set to UpdateFilePolicyError.Tag.ACCESS_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of UpdateFilePolicyError with its tag set to UpdateFilePolicyError.Tag.ACCESS_ERROR.

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharingFileAccessError getAccessErrorValue()

This instance must be tagged as UpdateFilePolicyError.Tag.ACCESS_ERROR.

Returns:

The SharingFileAccessError value associated with this instance if isAccessError() is true.

Throws:

IllegalStateException - If isAccessError() is false.

isInvalidFileSettings

public boolean isInvalidFileSettings()

Returns true if this instance has the tag UpdateFilePolicyError.Tag.INVALID_FILE_SETTINGS, false otherwise.

Returns:

true if this instance is tagged as UpdateFilePolicyError.Tag.INVALID_FILE_SETTINGS, false otherwise.

isNoPermission

public boolean isNoPermission()

Returns true if this instance has the tag UpdateFilePolicyError.Tag.NO_PERMISSION, false otherwise.

Returns:

true if this instance is tagged as UpdateFilePolicyError.Tag.NO_PERMISSION, false otherwise.

isOther

public boolean isOther()

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

Returns:

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