Class GetFileMetadataIndividualResult
- java.lang.Object
-
- com.dropbox.core.v2.sharing.GetFileMetadataIndividualResult
-
public final class GetFileMetadataIndividualResult extends java.lang.ObjectThis 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
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGetFileMetadataIndividualResult.TagDiscriminating tag type forGetFileMetadataIndividualResult.
-
Field Summary
Fields Modifier and Type Field Description static GetFileMetadataIndividualResultOTHERCatch-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 GetFileMetadataIndividualResultaccessError(SharingFileAccessError value)Returns an instance ofGetFileMetadataIndividualResultthat has its tag set toGetFileMetadataIndividualResult.Tag.ACCESS_ERROR.booleanequals(java.lang.Object obj)SharingFileAccessErrorgetAccessErrorValue()The result for this file if it was an error.SharedFileMetadatagetMetadataValue()The result for this file if it was successful.inthashCode()booleanisAccessError()Returnstrueif this instance has the tagGetFileMetadataIndividualResult.Tag.ACCESS_ERROR,falseotherwise.booleanisMetadata()Returnstrueif this instance has the tagGetFileMetadataIndividualResult.Tag.METADATA,falseotherwise.booleanisOther()Returnstrueif this instance has the tagGetFileMetadataIndividualResult.Tag.OTHER,falseotherwise.static GetFileMetadataIndividualResultmetadata(SharedFileMetadata value)Returns an instance ofGetFileMetadataIndividualResultthat has its tag set toGetFileMetadataIndividualResult.Tag.METADATA.GetFileMetadataIndividualResult.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()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 aswitchstatement to properly handle the different values for thisGetFileMetadataIndividualResult.If a tag returned by the server is unrecognized by this SDK, the
GetFileMetadataIndividualResult.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isMetadata
public boolean isMetadata()
Returnstrueif this instance has the tagGetFileMetadataIndividualResult.Tag.METADATA,falseotherwise.- Returns:
trueif this instance is tagged asGetFileMetadataIndividualResult.Tag.METADATA,falseotherwise.
-
metadata
public static GetFileMetadataIndividualResult metadata(SharedFileMetadata value)
Returns an instance ofGetFileMetadataIndividualResultthat 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
GetFileMetadataIndividualResultwith its tag set toGetFileMetadataIndividualResult.Tag.METADATA. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getMetadataValue
public SharedFileMetadata getMetadataValue()
The result for this file if it was successful.This instance must be tagged as
GetFileMetadataIndividualResult.Tag.METADATA.- Returns:
- The
SharedFileMetadatavalue associated with this instance ifisMetadata()istrue. - Throws:
java.lang.IllegalStateException- IfisMetadata()isfalse.
-
isAccessError
public boolean isAccessError()
Returnstrueif this instance has the tagGetFileMetadataIndividualResult.Tag.ACCESS_ERROR,falseotherwise.- Returns:
trueif this instance is tagged asGetFileMetadataIndividualResult.Tag.ACCESS_ERROR,falseotherwise.
-
accessError
public static GetFileMetadataIndividualResult accessError(SharingFileAccessError value)
Returns an instance ofGetFileMetadataIndividualResultthat 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
GetFileMetadataIndividualResultwith its tag set toGetFileMetadataIndividualResult.Tag.ACCESS_ERROR. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
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
SharingFileAccessErrorvalue associated with this instance ifisAccessError()istrue. - Throws:
java.lang.IllegalStateException- IfisAccessError()isfalse.
-
isOther
public boolean isOther()
Returnstrueif this instance has the tagGetFileMetadataIndividualResult.Tag.OTHER,falseotherwise.- Returns:
trueif this instance is tagged asGetFileMetadataIndividualResult.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin 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
-
-