com.dropbox.core.v2.files

Class PropertiesError

java.lang.Object

com.dropbox.core.v2.files.PropertiesError

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

Field Summary

Fields

Modifier and Type	Field and Description
static PropertiesError	OTHER An unspecified error.
static PropertiesError	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)
LookupError	getPathValue() This instance must be tagged as PropertiesError.Tag.PATH.
String	getTemplateNotFoundValue() Property template does not exist for given identifier.
int	hashCode()
boolean	isOther() Returns true if this instance has the tag PropertiesError.Tag.OTHER, false otherwise.
boolean	isPath() Returns true if this instance has the tag PropertiesError.Tag.PATH, false otherwise.
boolean	isRestrictedContent() Returns true if this instance has the tag PropertiesError.Tag.RESTRICTED_CONTENT, false otherwise.
boolean	isTemplateNotFound() Returns true if this instance has the tag PropertiesError.Tag.TEMPLATE_NOT_FOUND, false otherwise.
static PropertiesError	path(LookupError value) Returns an instance of PropertiesError that has its tag set to PropertiesError.Tag.PATH.
PropertiesError.Tag	tag() Returns the tag for this instance.
static PropertiesError	templateNotFound(String value) Returns an instance of PropertiesError that has its tag set to PropertiesError.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 PropertiesError RESTRICTED_CONTENT

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

OTHER

public static final PropertiesError OTHER

An unspecified error.

Method Detail

tag

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

Returns:

the tag for this instance.

isTemplateNotFound

public boolean isTemplateNotFound()

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

Returns:

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

templateNotFound

public static PropertiesError templateNotFound(String value)

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

Property template does not exist for given identifier.

Parameters:

value - value to assign to this instance.

Returns:

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

Returns:

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

isOther

public boolean isOther()

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

Returns:

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

isPath

public boolean isPath()

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

Returns:

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

path

public static PropertiesError path(LookupError value)

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

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getPathValue

public LookupError getPathValue()

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

Returns:

The path(com.dropbox.core.v2.files.LookupError) value associated with this instance if isPath() is true.

Throws:

IllegalStateException - If isPath() 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