Class TemplateError
- java.lang.Object
-
- com.dropbox.core.v2.fileproperties.TemplateError
-
public final class TemplateError 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
TemplateError.Serializer
For internal use only.static class
TemplateError.Tag
Discriminating tag type forTemplateError
.
-
Field Summary
Fields Modifier and Type Field Description static TemplateError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static TemplateError
RESTRICTED_CONTENT
You do not have permission to modify this template.
-
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
isOther()
boolean
isRestrictedContent()
boolean
isTemplateNotFound()
TemplateError.Tag
tag()
Returns the tag for this instance.static TemplateError
templateNotFound(java.lang.String value)
Returns an instance ofTemplateError
that has its tag set toTemplateError.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 TemplateError RESTRICTED_CONTENT
You do not have permission to modify this template.
-
OTHER
public static final TemplateError 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 TemplateError.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 thisTemplateError
.If a tag returned by the server is unrecognized by this SDK, the
TemplateError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isTemplateNotFound
public boolean isTemplateNotFound()
- Returns:
true
if this instance is tagged asTemplateError.Tag.TEMPLATE_NOT_FOUND
,false
otherwise.
-
templateNotFound
public static TemplateError templateNotFound(java.lang.String value)
Returns an instance ofTemplateError
that has its tag set toTemplateError.Tag.TEMPLATE_NOT_FOUND
.Template does not exist for the given identifier.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
TemplateError
with its tag set toTemplateError.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
TemplateError.Tag.TEMPLATE_NOT_FOUND
.- Returns:
- The
String
value associated with this instance ifisTemplateNotFound()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisTemplateNotFound()
isfalse
.
-
isRestrictedContent
public boolean isRestrictedContent()
- Returns:
true
if this instance is tagged asTemplateError.Tag.RESTRICTED_CONTENT
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asTemplateError.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
-
-