Package com.dropbox.core.v2.files
Class PreviewError
- java.lang.Object
- 
- com.dropbox.core.v2.files.PreviewError
 
- 
 public final class PreviewError extends java.lang.ObjectThis 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 SummaryNested Classes Modifier and Type Class Description static classPreviewError.TagDiscriminating tag type forPreviewError.
 - 
Field SummaryFields Modifier and Type Field Description static PreviewErrorIN_PROGRESSThis preview generation is still in progress and the file is not ready for preview yet.static PreviewErrorUNSUPPORTED_CONTENTThe file content is not supported for preview generation.static PreviewErrorUNSUPPORTED_EXTENSIONThe file extension is not supported preview generation.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)LookupErrorgetPathValue()An error occurs when downloading metadata for the file.inthashCode()booleanisInProgress()booleanisPath()booleanisUnsupportedContent()booleanisUnsupportedExtension()static PreviewErrorpath(LookupError value)Returns an instance ofPreviewErrorthat has its tag set toPreviewError.Tag.PATH.PreviewError.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- 
IN_PROGRESSpublic static final PreviewError IN_PROGRESS This preview generation is still in progress and the file is not ready for preview yet.
 - 
UNSUPPORTED_EXTENSIONpublic static final PreviewError UNSUPPORTED_EXTENSION The file extension is not supported preview generation.
 - 
UNSUPPORTED_CONTENTpublic static final PreviewError UNSUPPORTED_CONTENT The file content is not supported for preview generation.
 
- 
 - 
Method Detail- 
tagpublic PreviewError.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 thisPreviewError.- Returns:
- the tag for this instance.
 
 - 
isPathpublic boolean isPath() - Returns:
- trueif this instance is tagged as- PreviewError.Tag.PATH,- falseotherwise.
 
 - 
pathpublic static PreviewError path(LookupError value) Returns an instance ofPreviewErrorthat has its tag set toPreviewError.Tag.PATH.An error occurs when downloading metadata for the file. - Parameters:
- value- value to assign to this instance.
- Returns:
- Instance of PreviewErrorwith its tag set toPreviewError.Tag.PATH.
- Throws:
- java.lang.IllegalArgumentException- if- valueis- null.
 
 - 
getPathValuepublic LookupError getPathValue() An error occurs when downloading metadata for the file.This instance must be tagged as PreviewError.Tag.PATH.- Returns:
- The LookupErrorvalue associated with this instance ifisPath()istrue.
- Throws:
- java.lang.IllegalStateException- If- isPath()is- false.
 
 - 
isInProgresspublic boolean isInProgress() - Returns:
- trueif this instance is tagged as- PreviewError.Tag.IN_PROGRESS,- falseotherwise.
 
 - 
isUnsupportedExtensionpublic boolean isUnsupportedExtension() - Returns:
- trueif this instance is tagged as- PreviewError.Tag.UNSUPPORTED_EXTENSION,- falseotherwise.
 
 - 
isUnsupportedContentpublic boolean isUnsupportedContent() - Returns:
- trueif this instance is tagged as- PreviewError.Tag.UNSUPPORTED_CONTENT,- falseotherwise.
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- java.lang.Object
 
 - 
equalspublic boolean equals(java.lang.Object obj) - Overrides:
- equalsin class- java.lang.Object
 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 - 
toStringMultilinepublic 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
 
 
- 
 
-