Package com.dropbox.core.v2.fileproperties

Class TemplateError

java.lang.Object

com.dropbox.core.v2.fileproperties.TemplateError

public final class TemplateError
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 class	TemplateError.Serializer	For internal use only.
static enum	TemplateError.Tag	Discriminating tag type for TemplateError.

Field Summary

Fields

Modifier and Type	Field	Description
static final TemplateError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final TemplateError	RESTRICTED_CONTENT	You do not have permission to modify this template.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getTemplateNotFoundValue()	Template does not exist for the given identifier.
int	hashCode()
boolean	isOther()	Returns true if this instance has the tag TemplateError.Tag.OTHER, false otherwise.
boolean	isRestrictedContent()	Returns true if this instance has the tag TemplateError.Tag.RESTRICTED_CONTENT, false otherwise.
boolean	isTemplateNotFound()	Returns true if this instance has the tag TemplateError.Tag.TEMPLATE_NOT_FOUND, false otherwise.
TemplateError.Tag	tag()	Returns the tag for this instance.
static TemplateError	templateNotFound(String value)	Returns an instance of TemplateError that has its tag set to TemplateError.Tag.TEMPLATE_NOT_FOUND.
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

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 Details

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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this TemplateError.

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 has the tag TemplateError.Tag.TEMPLATE_NOT_FOUND, false otherwise.

Returns:

true if this instance is tagged as TemplateError.Tag.TEMPLATE_NOT_FOUND, false otherwise.

templateNotFound

public static TemplateError templateNotFound(String value)

Returns an instance of TemplateError that has its tag set to TemplateError.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 to TemplateError.Tag.TEMPLATE_NOT_FOUND.

Throws:

IllegalArgumentException - if value is shorter than 1, does not match pattern "(/|ptid:).*", or is null.

getTemplateNotFoundValue

public 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 if isTemplateNotFound() is true.

Throws:

IllegalStateException - If isTemplateNotFound() is false.

isRestrictedContent

public boolean isRestrictedContent()

Returns true if this instance has the tag TemplateError.Tag.RESTRICTED_CONTENT, false otherwise.

Returns:

true if this instance is tagged as TemplateError.Tag.RESTRICTED_CONTENT, false otherwise.

isOther

public boolean isOther()

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

Returns:

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