Class ModifyTemplateError
- java.lang.Object
-
- com.dropbox.core.v2.fileproperties.ModifyTemplateError
-
public final class ModifyTemplateError extends java.lang.Object
This class is a 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ModifyTemplateError.Serializer
For internal use only.static class
ModifyTemplateError.Tag
Discriminating tag type forModifyTemplateError
.
-
Field Summary
Fields Modifier and Type Field Description static ModifyTemplateError
CONFLICTING_PROPERTY_NAMES
A property field key with that name already exists in the template.static ModifyTemplateError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static ModifyTemplateError
RESTRICTED_CONTENT
You do not have permission to modify this template.static ModifyTemplateError
TEMPLATE_ATTRIBUTE_TOO_LARGE
The template name, description or one or more of the property field keys is too large.static ModifyTemplateError
TOO_MANY_PROPERTIES
There are too many properties in the changed template.static ModifyTemplateError
TOO_MANY_TEMPLATES
There are too many templates for the team.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getTemplateNotFoundValue()
Template does not exist for the given identifier.int
hashCode()
boolean
isConflictingPropertyNames()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.CONFLICTING_PROPERTY_NAMES
,false
otherwise.boolean
isOther()
boolean
isRestrictedContent()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.RESTRICTED_CONTENT
,false
otherwise.boolean
isTemplateAttributeTooLarge()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.TEMPLATE_ATTRIBUTE_TOO_LARGE
,false
otherwise.boolean
isTemplateNotFound()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.TEMPLATE_NOT_FOUND
,false
otherwise.boolean
isTooManyProperties()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.TOO_MANY_PROPERTIES
,false
otherwise.boolean
isTooManyTemplates()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.TOO_MANY_TEMPLATES
,false
otherwise.ModifyTemplateError.Tag
tag()
Returns the tag for this instance.static ModifyTemplateError
templateNotFound(java.lang.String value)
Returns an instance ofModifyTemplateError
that has its tag set toModifyTemplateError.Tag.TEMPLATE_NOT_FOUND
.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
RESTRICTED_CONTENT
public static final ModifyTemplateError RESTRICTED_CONTENT
You do not have permission to modify this template.
-
OTHER
public static final ModifyTemplateError 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.
-
CONFLICTING_PROPERTY_NAMES
public static final ModifyTemplateError CONFLICTING_PROPERTY_NAMES
A property field key with that name already exists in the template.
-
TOO_MANY_PROPERTIES
public static final ModifyTemplateError TOO_MANY_PROPERTIES
There are too many properties in the changed template. The maximum number of properties per template is 32.
-
TOO_MANY_TEMPLATES
public static final ModifyTemplateError TOO_MANY_TEMPLATES
There are too many templates for the team.
-
TEMPLATE_ATTRIBUTE_TOO_LARGE
public static final ModifyTemplateError TEMPLATE_ATTRIBUTE_TOO_LARGE
The template name, description or one or more of the property field keys is too large.
-
-
Method Detail
-
tag
public ModifyTemplateError.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 thisModifyTemplateError
.- Returns:
- the tag for this instance.
-
isTemplateNotFound
public boolean isTemplateNotFound()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.TEMPLATE_NOT_FOUND
,false
otherwise.- Returns:
true
if this instance is tagged asModifyTemplateError.Tag.TEMPLATE_NOT_FOUND
,false
otherwise.
-
templateNotFound
public static ModifyTemplateError templateNotFound(java.lang.String value)
Returns an instance ofModifyTemplateError
that has its tag set toModifyTemplateError.Tag.TEMPLATE_NOT_FOUND
.Template does not exist for the given identifier.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
ModifyTemplateError
with its tag set toModifyTemplateError.Tag.TEMPLATE_NOT_FOUND
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
is shorter than 1, does not match pattern "(/|ptid:).*
", or isnull
.
-
getTemplateNotFoundValue
public java.lang.String getTemplateNotFoundValue()
Template does not exist for the given identifier.This instance must be tagged as
ModifyTemplateError.Tag.TEMPLATE_NOT_FOUND
.- Returns:
- The
String
value associated with this instance ifisTemplateNotFound()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisTemplateNotFound()
isfalse
.
-
isRestrictedContent
public boolean isRestrictedContent()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.RESTRICTED_CONTENT
,false
otherwise.- Returns:
true
if this instance is tagged asModifyTemplateError.Tag.RESTRICTED_CONTENT
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asModifyTemplateError.Tag.OTHER
,false
otherwise.
-
isConflictingPropertyNames
public boolean isConflictingPropertyNames()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.CONFLICTING_PROPERTY_NAMES
,false
otherwise.- Returns:
true
if this instance is tagged asModifyTemplateError.Tag.CONFLICTING_PROPERTY_NAMES
,false
otherwise.
-
isTooManyProperties
public boolean isTooManyProperties()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.TOO_MANY_PROPERTIES
,false
otherwise.- Returns:
true
if this instance is tagged asModifyTemplateError.Tag.TOO_MANY_PROPERTIES
,false
otherwise.
-
isTooManyTemplates
public boolean isTooManyTemplates()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.TOO_MANY_TEMPLATES
,false
otherwise.- Returns:
true
if this instance is tagged asModifyTemplateError.Tag.TOO_MANY_TEMPLATES
,false
otherwise.
-
isTemplateAttributeTooLarge
public boolean isTemplateAttributeTooLarge()
Returnstrue
if this instance has the tagModifyTemplateError.Tag.TEMPLATE_ATTRIBUTE_TOO_LARGE
,false
otherwise.- Returns:
true
if this instance is tagged asModifyTemplateError.Tag.TEMPLATE_ATTRIBUTE_TOO_LARGE
,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
-
-