Package com.dropbox.core.v2.team

Class TeamFolderCreateError

java.lang.Object

com.dropbox.core.v2.team.TeamFolderCreateError

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

Field Summary

Fields

Modifier and Type	Field	Description
static final TeamFolderCreateError	FOLDER_NAME_ALREADY_USED	There is already a team folder with the provided name.
static final TeamFolderCreateError	FOLDER_NAME_RESERVED	The provided name cannot be used because it is reserved.
static final TeamFolderCreateError	INVALID_FOLDER_NAME	The provided name cannot be used.
static final TeamFolderCreateError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
SyncSettingsError	getSyncSettingsErrorValue()	An error occurred setting the sync settings.
int	hashCode()
boolean	isFolderNameAlreadyUsed()	Returns true if this instance has the tag TeamFolderCreateError.Tag.FOLDER_NAME_ALREADY_USED, false otherwise.
boolean	isFolderNameReserved()	Returns true if this instance has the tag TeamFolderCreateError.Tag.FOLDER_NAME_RESERVED, false otherwise.
boolean	isInvalidFolderName()	Returns true if this instance has the tag TeamFolderCreateError.Tag.INVALID_FOLDER_NAME, false otherwise.
boolean	isOther()	Returns true if this instance has the tag TeamFolderCreateError.Tag.OTHER, false otherwise.
boolean	isSyncSettingsError()	Returns true if this instance has the tag TeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR, false otherwise.
static TeamFolderCreateError	syncSettingsError(SyncSettingsError value)	Returns an instance of TeamFolderCreateError that has its tag set to TeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR.
TeamFolderCreateError.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_FOLDER_NAME

public static final TeamFolderCreateError INVALID_FOLDER_NAME

The provided name cannot be used.

FOLDER_NAME_ALREADY_USED

public static final TeamFolderCreateError FOLDER_NAME_ALREADY_USED

There is already a team folder with the provided name.

FOLDER_NAME_RESERVED

public static final TeamFolderCreateError FOLDER_NAME_RESERVED

The provided name cannot be used because it is reserved.

OTHER

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

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

Returns:

the tag for this instance.

isInvalidFolderName

public boolean isInvalidFolderName()

Returns true if this instance has the tag TeamFolderCreateError.Tag.INVALID_FOLDER_NAME, false otherwise.

Returns:

true if this instance is tagged as TeamFolderCreateError.Tag.INVALID_FOLDER_NAME, false otherwise.

isFolderNameAlreadyUsed

public boolean isFolderNameAlreadyUsed()

Returns true if this instance has the tag TeamFolderCreateError.Tag.FOLDER_NAME_ALREADY_USED, false otherwise.

Returns:

true if this instance is tagged as TeamFolderCreateError.Tag.FOLDER_NAME_ALREADY_USED, false otherwise.

isFolderNameReserved

public boolean isFolderNameReserved()

Returns true if this instance has the tag TeamFolderCreateError.Tag.FOLDER_NAME_RESERVED, false otherwise.

Returns:

true if this instance is tagged as TeamFolderCreateError.Tag.FOLDER_NAME_RESERVED, false otherwise.

isSyncSettingsError

public boolean isSyncSettingsError()

Returns true if this instance has the tag TeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR, false otherwise.

Returns:

true if this instance is tagged as TeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR, false otherwise.

syncSettingsError

public static TeamFolderCreateError syncSettingsError(SyncSettingsError value)

Returns an instance of TeamFolderCreateError that has its tag set to TeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR.

An error occurred setting the sync settings.

Parameters:

value - value to assign to this instance.

Returns:

Instance of TeamFolderCreateError with its tag set to TeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR.

Throws:

IllegalArgumentException - if value is null.

getSyncSettingsErrorValue

public SyncSettingsError getSyncSettingsErrorValue()

An error occurred setting the sync settings.

This instance must be tagged as TeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR.

Returns:

The SyncSettingsError value associated with this instance if isSyncSettingsError() is true.

Throws:

IllegalStateException - If isSyncSettingsError() is false.

isOther

public boolean isOther()

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

Returns:

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