Class TeamFolderCreateError
- java.lang.Object
-
- com.dropbox.core.v2.team.TeamFolderCreateError
-
public final class TeamFolderCreateError extends java.lang.Object
This 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
OTHER
value will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TeamFolderCreateError.Tag
Discriminating tag type forTeamFolderCreateError
.
-
Field Summary
Fields Modifier and Type Field Description static TeamFolderCreateError
FOLDER_NAME_ALREADY_USED
There is already a team folder with the provided name.static TeamFolderCreateError
FOLDER_NAME_RESERVED
The provided name cannot be used because it is reserved.static TeamFolderCreateError
INVALID_FOLDER_NAME
The provided name cannot be used.static TeamFolderCreateError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
SyncSettingsError
getSyncSettingsErrorValue()
An error occurred setting the sync settings.int
hashCode()
boolean
isFolderNameAlreadyUsed()
Returnstrue
if this instance has the tagTeamFolderCreateError.Tag.FOLDER_NAME_ALREADY_USED
,false
otherwise.boolean
isFolderNameReserved()
Returnstrue
if this instance has the tagTeamFolderCreateError.Tag.FOLDER_NAME_RESERVED
,false
otherwise.boolean
isInvalidFolderName()
Returnstrue
if this instance has the tagTeamFolderCreateError.Tag.INVALID_FOLDER_NAME
,false
otherwise.boolean
isOther()
boolean
isSyncSettingsError()
Returnstrue
if this instance has the tagTeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR
,false
otherwise.static TeamFolderCreateError
syncSettingsError(SyncSettingsError value)
Returns an instance ofTeamFolderCreateError
that has its tag set toTeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR
.TeamFolderCreateError.Tag
tag()
Returns the tag for this instance.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
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 Detail
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisTeamFolderCreateError
.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()
Returnstrue
if this instance has the tagTeamFolderCreateError.Tag.INVALID_FOLDER_NAME
,false
otherwise.- Returns:
true
if this instance is tagged asTeamFolderCreateError.Tag.INVALID_FOLDER_NAME
,false
otherwise.
-
isFolderNameAlreadyUsed
public boolean isFolderNameAlreadyUsed()
Returnstrue
if this instance has the tagTeamFolderCreateError.Tag.FOLDER_NAME_ALREADY_USED
,false
otherwise.- Returns:
true
if this instance is tagged asTeamFolderCreateError.Tag.FOLDER_NAME_ALREADY_USED
,false
otherwise.
-
isFolderNameReserved
public boolean isFolderNameReserved()
Returnstrue
if this instance has the tagTeamFolderCreateError.Tag.FOLDER_NAME_RESERVED
,false
otherwise.- Returns:
true
if this instance is tagged asTeamFolderCreateError.Tag.FOLDER_NAME_RESERVED
,false
otherwise.
-
isSyncSettingsError
public boolean isSyncSettingsError()
Returnstrue
if this instance has the tagTeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR
,false
otherwise.- Returns:
true
if this instance is tagged asTeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR
,false
otherwise.
-
syncSettingsError
public static TeamFolderCreateError syncSettingsError(SyncSettingsError value)
Returns an instance ofTeamFolderCreateError
that has its tag set toTeamFolderCreateError.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 toTeamFolderCreateError.Tag.SYNC_SETTINGS_ERROR
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisSyncSettingsError()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisSyncSettingsError()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asTeamFolderCreateError.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in 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
-
-