com.dropbox.core.v2.files

Class MediaInfo

java.lang.Object

com.dropbox.core.v2.files.MediaInfo

public final class MediaInfo
extends java.lang.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	MediaInfo.Tag Discriminating tag type for MediaInfo.

Field Summary

Fields

Modifier and Type	Field and Description
static MediaInfo	PENDING Indicate the photo/video is still under processing and metadata is not available yet.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
MediaMetadata	getMetadataValue() The metadata for the photo/video.
int	hashCode()
boolean	isMetadata() Returns true if this instance has the tag MediaInfo.Tag.METADATA, false otherwise.
boolean	isPending() Returns true if this instance has the tag MediaInfo.Tag.PENDING, false otherwise.
static MediaInfo	metadata(MediaMetadata value) Returns an instance of MediaInfo that has its tag set to MediaInfo.Tag.METADATA.
MediaInfo.Tag	tag() Returns the tag for this instance.
java.lang.String	toString()
java.lang.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

PENDING

public static final MediaInfo PENDING

Indicate the photo/video is still under processing and metadata is not available yet.

Method Detail

tag

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

Returns:

the tag for this instance.

isPending

public boolean isPending()

Returns true if this instance has the tag MediaInfo.Tag.PENDING, false otherwise.

Returns:

true if this instance is tagged as MediaInfo.Tag.PENDING, false otherwise.

isMetadata

public boolean isMetadata()

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

Returns:

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

metadata

public static MediaInfo metadata(MediaMetadata value)

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

The metadata for the photo/video.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if value is null.

getMetadataValue

public MediaMetadata getMetadataValue()

The metadata for the photo/video.

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

Returns:

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

Throws:

java.lang.IllegalStateException - If isMetadata() is false.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

public java.lang.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