com.dropbox.core.v2.properties

Class PropertyTemplateError

java.lang.Object

com.dropbox.core.v2.properties.PropertyTemplateError

public final class PropertyTemplateError
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 and Description
static class	PropertyTemplateError.Tag Discriminating tag type for PropertyTemplateError.

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyTemplateError	OTHER An unspecified error.
static PropertyTemplateError	RESTRICTED_CONTENT You do not have the permissions to modify this property template.

Method Summary

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

RESTRICTED_CONTENT

public static final PropertyTemplateError RESTRICTED_CONTENT

You do not have the permissions to modify this property template.

OTHER

public static final PropertyTemplateError OTHER

An unspecified error.

Method Detail

tag

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

If a tag returned by the server is unrecognized by this SDK, the PropertyTemplateError.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isTemplateNotFound

public boolean isTemplateNotFound()

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

Returns:

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

templateNotFound

public static PropertyTemplateError templateNotFound(String value)

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

Property template does not exist for given identifier.

Parameters:

value - value to assign to this instance.

Returns:

Instance of PropertyTemplateError with its tag set to PropertyTemplateError.Tag.TEMPLATE_NOT_FOUND.

Throws:

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

getTemplateNotFoundValue

public String getTemplateNotFoundValue()

Property template does not exist for given identifier.

This instance must be tagged as PropertyTemplateError.Tag.TEMPLATE_NOT_FOUND.

Returns:

The templateNotFound(java.lang.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 PropertyTemplateError.Tag.RESTRICTED_CONTENT, false otherwise.

Returns:

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

isOther

public boolean isOther()

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

Returns:

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