Package com.dropbox.core.v2.fileproperties

Class UpdatePropertiesError

java.lang.Object

com.dropbox.core.v2.fileproperties.UpdatePropertiesError

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

Field Summary

Fields

Modifier and Type	Field	Description
static final UpdatePropertiesError	DOES_NOT_FIT_TEMPLATE	One or more of the supplied property fields does not conform to the template specifications.
static final UpdatePropertiesError	DUPLICATE_PROPERTY_GROUPS	There are 2 or more property groups referring to the same templates in the input.
static final UpdatePropertiesError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final UpdatePropertiesError	PROPERTY_FIELD_TOO_LARGE	One or more of the supplied property field values is too large.
static final UpdatePropertiesError	RESTRICTED_CONTENT	You do not have permission to modify this template.
static final UpdatePropertiesError	UNSUPPORTED_FOLDER	This folder cannot be tagged.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
LookupError	getPathValue()	This instance must be tagged as UpdatePropertiesError.Tag.PATH.
LookUpPropertiesError	getPropertyGroupLookupValue()	This instance must be tagged as UpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP.
String	getTemplateNotFoundValue()	Template does not exist for the given identifier.
int	hashCode()
boolean	isDoesNotFitTemplate()	Returns true if this instance has the tag UpdatePropertiesError.Tag.DOES_NOT_FIT_TEMPLATE, false otherwise.
boolean	isDuplicatePropertyGroups()	Returns true if this instance has the tag UpdatePropertiesError.Tag.DUPLICATE_PROPERTY_GROUPS, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UpdatePropertiesError.Tag.OTHER, false otherwise.
boolean	isPath()	Returns true if this instance has the tag UpdatePropertiesError.Tag.PATH, false otherwise.
boolean	isPropertyFieldTooLarge()	Returns true if this instance has the tag UpdatePropertiesError.Tag.PROPERTY_FIELD_TOO_LARGE, false otherwise.
boolean	isPropertyGroupLookup()	Returns true if this instance has the tag UpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP, false otherwise.
boolean	isRestrictedContent()	Returns true if this instance has the tag UpdatePropertiesError.Tag.RESTRICTED_CONTENT, false otherwise.
boolean	isTemplateNotFound()	Returns true if this instance has the tag UpdatePropertiesError.Tag.TEMPLATE_NOT_FOUND, false otherwise.
boolean	isUnsupportedFolder()	Returns true if this instance has the tag UpdatePropertiesError.Tag.UNSUPPORTED_FOLDER, false otherwise.
static UpdatePropertiesError	path(LookupError value)	Returns an instance of UpdatePropertiesError that has its tag set to UpdatePropertiesError.Tag.PATH.
static UpdatePropertiesError	propertyGroupLookup(LookUpPropertiesError value)	Returns an instance of UpdatePropertiesError that has its tag set to UpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP.
UpdatePropertiesError.Tag	tag()	Returns the tag for this instance.
static UpdatePropertiesError	templateNotFound(String value)	Returns an instance of UpdatePropertiesError that has its tag set to UpdatePropertiesError.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 UpdatePropertiesError RESTRICTED_CONTENT

You do not have permission to modify this template.

OTHER

public static final UpdatePropertiesError 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.

UNSUPPORTED_FOLDER

public static final UpdatePropertiesError UNSUPPORTED_FOLDER

This folder cannot be tagged. Tagging folders is not supported for team-owned templates.

PROPERTY_FIELD_TOO_LARGE

public static final UpdatePropertiesError PROPERTY_FIELD_TOO_LARGE

One or more of the supplied property field values is too large.

DOES_NOT_FIT_TEMPLATE

public static final UpdatePropertiesError DOES_NOT_FIT_TEMPLATE

One or more of the supplied property fields does not conform to the template specifications.

DUPLICATE_PROPERTY_GROUPS

public static final UpdatePropertiesError DUPLICATE_PROPERTY_GROUPS

There are 2 or more property groups referring to the same templates in the input.

Method Details

tag

public UpdatePropertiesError.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 UpdatePropertiesError.

Returns:

the tag for this instance.

isTemplateNotFound

public boolean isTemplateNotFound()

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

Returns:

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

templateNotFound

public static UpdatePropertiesError templateNotFound(String value)

Returns an instance of UpdatePropertiesError that has its tag set to UpdatePropertiesError.Tag.TEMPLATE_NOT_FOUND.

Template does not exist for the given identifier.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UpdatePropertiesError with its tag set to UpdatePropertiesError.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 UpdatePropertiesError.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 UpdatePropertiesError.Tag.RESTRICTED_CONTENT, false otherwise.

Returns:

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

isOther

public boolean isOther()

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

Returns:

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

isPath

public boolean isPath()

Returns true if this instance has the tag UpdatePropertiesError.Tag.PATH, false otherwise.

Returns:

true if this instance is tagged as UpdatePropertiesError.Tag.PATH, false otherwise.

path

public static UpdatePropertiesError path(LookupError value)

Returns an instance of UpdatePropertiesError that has its tag set to UpdatePropertiesError.Tag.PATH.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of UpdatePropertiesError with its tag set to UpdatePropertiesError.Tag.PATH.

Throws:

IllegalArgumentException - if value is null.

getPathValue

public LookupError getPathValue()

This instance must be tagged as UpdatePropertiesError.Tag.PATH.

Returns:

The LookupError value associated with this instance if isPath() is true.

Throws:

IllegalStateException - If isPath() is false.

isUnsupportedFolder

public boolean isUnsupportedFolder()

Returns true if this instance has the tag UpdatePropertiesError.Tag.UNSUPPORTED_FOLDER, false otherwise.

Returns:

true if this instance is tagged as UpdatePropertiesError.Tag.UNSUPPORTED_FOLDER, false otherwise.

isPropertyFieldTooLarge

public boolean isPropertyFieldTooLarge()

Returns true if this instance has the tag UpdatePropertiesError.Tag.PROPERTY_FIELD_TOO_LARGE, false otherwise.

Returns:

true if this instance is tagged as UpdatePropertiesError.Tag.PROPERTY_FIELD_TOO_LARGE, false otherwise.

isDoesNotFitTemplate

public boolean isDoesNotFitTemplate()

Returns true if this instance has the tag UpdatePropertiesError.Tag.DOES_NOT_FIT_TEMPLATE, false otherwise.

Returns:

true if this instance is tagged as UpdatePropertiesError.Tag.DOES_NOT_FIT_TEMPLATE, false otherwise.

isDuplicatePropertyGroups

public boolean isDuplicatePropertyGroups()

Returns true if this instance has the tag UpdatePropertiesError.Tag.DUPLICATE_PROPERTY_GROUPS, false otherwise.

Returns:

true if this instance is tagged as UpdatePropertiesError.Tag.DUPLICATE_PROPERTY_GROUPS, false otherwise.

isPropertyGroupLookup

public boolean isPropertyGroupLookup()

Returns true if this instance has the tag UpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP, false otherwise.

Returns:

true if this instance is tagged as UpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP, false otherwise.

propertyGroupLookup

public static UpdatePropertiesError propertyGroupLookup(LookUpPropertiesError value)

Returns an instance of UpdatePropertiesError that has its tag set to UpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of UpdatePropertiesError with its tag set to UpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP.

Throws:

IllegalArgumentException - if value is null.

getPropertyGroupLookupValue

public LookUpPropertiesError getPropertyGroupLookupValue()

This instance must be tagged as UpdatePropertiesError.Tag.PROPERTY_GROUP_LOOKUP.

Returns:

The LookUpPropertiesError value associated with this instance if isPropertyGroupLookup() is true.

Throws:

IllegalStateException - If isPropertyGroupLookup() is false.

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