Package com.dropbox.core.v2.sharing

Class GetFileMetadataIndividualResult

java.lang.Object

com.dropbox.core.v2.sharing.GetFileMetadataIndividualResult

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

Field Summary

Fields

Modifier and Type	Field	Description
static final GetFileMetadataIndividualResult	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static GetFileMetadataIndividualResult	accessError(SharingFileAccessError value)	Returns an instance of GetFileMetadataIndividualResult that has its tag set to GetFileMetadataIndividualResult.Tag.ACCESS_ERROR.
boolean	equals(Object obj)
SharingFileAccessError	getAccessErrorValue()	The result for this file if it was an error.
SharedFileMetadata	getMetadataValue()	The result for this file if it was successful.
int	hashCode()
boolean	isAccessError()	Returns true if this instance has the tag GetFileMetadataIndividualResult.Tag.ACCESS_ERROR, false otherwise.
boolean	isMetadata()	Returns true if this instance has the tag GetFileMetadataIndividualResult.Tag.METADATA, false otherwise.
boolean	isOther()	Returns true if this instance has the tag GetFileMetadataIndividualResult.Tag.OTHER, false otherwise.
static GetFileMetadataIndividualResult	metadata(SharedFileMetadata value)	Returns an instance of GetFileMetadataIndividualResult that has its tag set to GetFileMetadataIndividualResult.Tag.METADATA.
GetFileMetadataIndividualResult.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 Details

OTHER

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

Method Details

tag

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

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

Returns:

the tag for this instance.

isMetadata

public boolean isMetadata()

Returns true if this instance has the tag GetFileMetadataIndividualResult.Tag.METADATA, false otherwise.

Returns:

true if this instance is tagged as GetFileMetadataIndividualResult.Tag.METADATA, false otherwise.

metadata

public static GetFileMetadataIndividualResult metadata(SharedFileMetadata value)

Returns an instance of GetFileMetadataIndividualResult that has its tag set to GetFileMetadataIndividualResult.Tag.METADATA.

The result for this file if it was successful.

Parameters:

value - value to assign to this instance.

Returns:

Instance of GetFileMetadataIndividualResult with its tag set to GetFileMetadataIndividualResult.Tag.METADATA.

Throws:

IllegalArgumentException - if value is null.

getMetadataValue

public SharedFileMetadata getMetadataValue()

The result for this file if it was successful.

This instance must be tagged as GetFileMetadataIndividualResult.Tag.METADATA.

Returns:

The SharedFileMetadata value associated with this instance if isMetadata() is true.

Throws:

IllegalStateException - If isMetadata() is false.

isAccessError

public boolean isAccessError()

Returns true if this instance has the tag GetFileMetadataIndividualResult.Tag.ACCESS_ERROR, false otherwise.

Returns:

true if this instance is tagged as GetFileMetadataIndividualResult.Tag.ACCESS_ERROR, false otherwise.

accessError

public static GetFileMetadataIndividualResult accessError(SharingFileAccessError value)

Returns an instance of GetFileMetadataIndividualResult that has its tag set to GetFileMetadataIndividualResult.Tag.ACCESS_ERROR.

The result for this file if it was an error.

Parameters:

value - value to assign to this instance.

Returns:

Instance of GetFileMetadataIndividualResult with its tag set to GetFileMetadataIndividualResult.Tag.ACCESS_ERROR.

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharingFileAccessError getAccessErrorValue()

The result for this file if it was an error.

This instance must be tagged as GetFileMetadataIndividualResult.Tag.ACCESS_ERROR.

Returns:

The SharingFileAccessError value associated with this instance if isAccessError() is true.

Throws:

IllegalStateException - If isAccessError() is false.

isOther

public boolean isOther()

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

Returns:

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