Class GetFileMetadataIndividualResult
- java.lang.Object
-
- com.dropbox.core.v2.sharing.GetFileMetadataIndividualResult
-
public final class GetFileMetadataIndividualResult extends java.lang.Object
This class is an open 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.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 class
GetFileMetadataIndividualResult.Tag
Discriminating tag type forGetFileMetadataIndividualResult
.
-
Field Summary
Fields Modifier and Type Field Description static GetFileMetadataIndividualResult
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetFileMetadataIndividualResult
accessError(SharingFileAccessError value)
Returns an instance ofGetFileMetadataIndividualResult
that has its tag set toGetFileMetadataIndividualResult.Tag.ACCESS_ERROR
.boolean
equals(java.lang.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()
Returnstrue
if this instance has the tagGetFileMetadataIndividualResult.Tag.ACCESS_ERROR
,false
otherwise.boolean
isMetadata()
Returnstrue
if this instance has the tagGetFileMetadataIndividualResult.Tag.METADATA
,false
otherwise.boolean
isOther()
Returnstrue
if this instance has the tagGetFileMetadataIndividualResult.Tag.OTHER
,false
otherwise.static GetFileMetadataIndividualResult
metadata(SharedFileMetadata value)
Returns an instance ofGetFileMetadataIndividualResult
that has its tag set toGetFileMetadataIndividualResult.Tag.METADATA
.GetFileMetadataIndividualResult.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
-
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 Detail
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisGetFileMetadataIndividualResult
.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()
Returnstrue
if this instance has the tagGetFileMetadataIndividualResult.Tag.METADATA
,false
otherwise.- Returns:
true
if this instance is tagged asGetFileMetadataIndividualResult.Tag.METADATA
,false
otherwise.
-
metadata
public static GetFileMetadataIndividualResult metadata(SharedFileMetadata value)
Returns an instance ofGetFileMetadataIndividualResult
that has its tag set toGetFileMetadataIndividualResult.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 toGetFileMetadataIndividualResult.Tag.METADATA
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisMetadata()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisMetadata()
isfalse
.
-
isAccessError
public boolean isAccessError()
Returnstrue
if this instance has the tagGetFileMetadataIndividualResult.Tag.ACCESS_ERROR
,false
otherwise.- Returns:
true
if this instance is tagged asGetFileMetadataIndividualResult.Tag.ACCESS_ERROR
,false
otherwise.
-
accessError
public static GetFileMetadataIndividualResult accessError(SharingFileAccessError value)
Returns an instance ofGetFileMetadataIndividualResult
that has its tag set toGetFileMetadataIndividualResult.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 toGetFileMetadataIndividualResult.Tag.ACCESS_ERROR
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisAccessError()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisAccessError()
isfalse
.
-
isOther
public boolean isOther()
Returnstrue
if this instance has the tagGetFileMetadataIndividualResult.Tag.OTHER
,false
otherwise.- Returns:
true
if this instance is tagged asGetFileMetadataIndividualResult.Tag.OTHER
,false
otherwise.
-
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
-
-