Package com.dropbox.core.v2.fileproperties

Class ModifyTemplateError

java.lang.Object

com.dropbox.core.v2.fileproperties.ModifyTemplateError

public final class ModifyTemplateError
extends Object

This class is a 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModifyTemplateError.Serializer	For internal use only.
static enum	ModifyTemplateError.Tag	Discriminating tag type for ModifyTemplateError.

Field Summary

Fields

Modifier and Type	Field	Description
static final ModifyTemplateError	CONFLICTING_PROPERTY_NAMES	A property field key with that name already exists in the template.
static final ModifyTemplateError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final ModifyTemplateError	RESTRICTED_CONTENT	You do not have permission to modify this template.
static final ModifyTemplateError	TEMPLATE_ATTRIBUTE_TOO_LARGE	The template name, description or one or more of the property field keys is too large.
static final ModifyTemplateError	TOO_MANY_PROPERTIES	There are too many properties in the changed template.
static final ModifyTemplateError	TOO_MANY_TEMPLATES	There are too many templates for the team.

Method Summary

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

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

Returns:

the tag for this instance.

isTemplateNotFound

public boolean isTemplateNotFound()

Returns true if this instance has the tag ModifyTemplateError.Tag.TEMPLATE_NOT_FOUND, false otherwise.

Returns:

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

templateNotFound

public static ModifyTemplateError templateNotFound(String value)

Returns an instance of ModifyTemplateError that has its tag set to ModifyTemplateError.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 to ModifyTemplateError.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 ModifyTemplateError.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 ModifyTemplateError.Tag.RESTRICTED_CONTENT, false otherwise.

Returns:

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

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as ModifyTemplateError.Tag.OTHER, false otherwise.

isConflictingPropertyNames

public boolean isConflictingPropertyNames()

Returns true if this instance has the tag ModifyTemplateError.Tag.CONFLICTING_PROPERTY_NAMES, false otherwise.

Returns:

true if this instance is tagged as ModifyTemplateError.Tag.CONFLICTING_PROPERTY_NAMES, false otherwise.

isTooManyProperties

public boolean isTooManyProperties()

Returns true if this instance has the tag ModifyTemplateError.Tag.TOO_MANY_PROPERTIES, false otherwise.

Returns:

true if this instance is tagged as ModifyTemplateError.Tag.TOO_MANY_PROPERTIES, false otherwise.

isTooManyTemplates

public boolean isTooManyTemplates()

Returns true if this instance has the tag ModifyTemplateError.Tag.TOO_MANY_TEMPLATES, false otherwise.

Returns:

true if this instance is tagged as ModifyTemplateError.Tag.TOO_MANY_TEMPLATES, false otherwise.

isTemplateAttributeTooLarge

public boolean isTemplateAttributeTooLarge()

Returns true if this instance has the tag ModifyTemplateError.Tag.TEMPLATE_ATTRIBUTE_TOO_LARGE, false otherwise.

Returns:

true if this instance is tagged as ModifyTemplateError.Tag.TEMPLATE_ATTRIBUTE_TOO_LARGE, 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