com.dropbox.core.v2.files

Class UploadErrorWithProperties

java.lang.Object

com.dropbox.core.v2.files.UploadErrorWithProperties

public final class UploadErrorWithProperties
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	UploadErrorWithProperties.Tag Discriminating tag type for UploadErrorWithProperties.

Field Summary

Fields

Modifier and Type	Field and Description
static UploadErrorWithProperties	OTHER An unspecified error.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
UploadWriteFailed	getPathValue() Unable to save the uploaded contents to a file.
InvalidPropertyGroupError	getPropertiesErrorValue() This instance must be tagged as UploadErrorWithProperties.Tag.PROPERTIES_ERROR.
int	hashCode()
boolean	isOther() Returns true if this instance has the tag UploadErrorWithProperties.Tag.OTHER, false otherwise.
boolean	isPath() Returns true if this instance has the tag UploadErrorWithProperties.Tag.PATH, false otherwise.
boolean	isPropertiesError() Returns true if this instance has the tag UploadErrorWithProperties.Tag.PROPERTIES_ERROR, false otherwise.
static UploadErrorWithProperties	path(UploadWriteFailed value) Returns an instance of UploadErrorWithProperties that has its tag set to UploadErrorWithProperties.Tag.PATH.
static UploadErrorWithProperties	propertiesError(InvalidPropertyGroupError value) Returns an instance of UploadErrorWithProperties that has its tag set to UploadErrorWithProperties.Tag.PROPERTIES_ERROR.
UploadErrorWithProperties.Tag	tag() Returns the tag for this instance.
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

OTHER

public static final UploadErrorWithProperties OTHER

An unspecified error.

Method Detail

tag

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

Returns:

the tag for this instance.

isPath

public boolean isPath()

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

Returns:

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

path

public static UploadErrorWithProperties path(UploadWriteFailed value)

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

Unable to save the uploaded contents to a file.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getPathValue

public UploadWriteFailed getPathValue()

Unable to save the uploaded contents to a file.

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

Returns:

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

Throws:

IllegalStateException - If isPath() is false.

isOther

public boolean isOther()

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

Returns:

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

isPropertiesError

public boolean isPropertiesError()

Returns true if this instance has the tag UploadErrorWithProperties.Tag.PROPERTIES_ERROR, false otherwise.

Returns:

true if this instance is tagged as UploadErrorWithProperties.Tag.PROPERTIES_ERROR, false otherwise.

propertiesError

public static UploadErrorWithProperties propertiesError(InvalidPropertyGroupError value)

Returns an instance of UploadErrorWithProperties that has its tag set to UploadErrorWithProperties.Tag.PROPERTIES_ERROR.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UploadErrorWithProperties with its tag set to UploadErrorWithProperties.Tag.PROPERTIES_ERROR.

Throws:

IllegalArgumentException - if value is null.

getPropertiesErrorValue

public InvalidPropertyGroupError getPropertiesErrorValue()

This instance must be tagged as UploadErrorWithProperties.Tag.PROPERTIES_ERROR.

Returns:

The propertiesError(com.dropbox.core.v2.files.InvalidPropertyGroupError) value associated with this instance if isPropertiesError() is true.

Throws:

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