Package 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 theisAbc()
methods will returntrue
. You can usetag()
to determine the tag associated with this instance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MediaInfo.Tag
Discriminating tag type forMediaInfo
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
MediaMetadata
getMetadataValue()
The metadata for the photo/video.int
hashCode()
boolean
isMetadata()
boolean
isPending()
static MediaInfo
metadata(MediaMetadata value)
Returns an instance ofMediaInfo
that has its tag set toMediaInfo.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.
-
-
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisMediaInfo
.- Returns:
- the tag for this instance.
-
isPending
public boolean isPending()
- Returns:
true
if this instance is tagged asMediaInfo.Tag.PENDING
,false
otherwise.
-
isMetadata
public boolean isMetadata()
- Returns:
true
if this instance is tagged asMediaInfo.Tag.METADATA
,false
otherwise.
-
metadata
public static MediaInfo metadata(MediaMetadata value)
Returns an instance ofMediaInfo
that has its tag set toMediaInfo.Tag.METADATA
.The metadata for the photo/video.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
MediaInfo
with its tag set toMediaInfo.Tag.METADATA
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisMetadata()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisMetadata()
isfalse
.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.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
-
-