PreviewError (Official Dropbox Java SDK 4.0.0 API)

java.lang.Object
- com.dropbox.core.v2.files.PreviewError

```
public final class PreviewError
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 PreviewError.Tag
Discriminating tag type for PreviewError.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PreviewError.Tag` Discriminating tag type for `PreviewError`.

Field Summary

Fields
Modifier and Type	Field and Description
`static PreviewError`	`IN_PROGRESS` This preview generation is still in progress and the file is not ready for preview yet.
`static PreviewError`	`UNSUPPORTED_CONTENT` The file content is not supported for preview generation.
`static PreviewError`	`UNSUPPORTED_EXTENSION` The file extension is not supported preview generation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`LookupError`	`getPathValue()` An error occurs when downloading metadata for the file.
`int`	`hashCode()`
`boolean`	`isInProgress()` Returns `true` if this instance has the tag `PreviewError.Tag.IN_PROGRESS`, `false` otherwise.
`boolean`	`isPath()` Returns `true` if this instance has the tag `PreviewError.Tag.PATH`, `false` otherwise.
`boolean`	`isUnsupportedContent()` Returns `true` if this instance has the tag `PreviewError.Tag.UNSUPPORTED_CONTENT`, `false` otherwise.
`boolean`	`isUnsupportedExtension()` Returns `true` if this instance has the tag `PreviewError.Tag.UNSUPPORTED_EXTENSION`, `false` otherwise.
`static PreviewError`	`path(LookupError value)` Returns an instance of `PreviewError` that has its tag set to `PreviewError.Tag.PATH`.
`PreviewError.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
  - IN_PROGRESS
```
public static final PreviewError IN_PROGRESS
```
    This preview generation is still in progress and the file is not ready for preview yet.
  - UNSUPPORTED_EXTENSION
```
public static final PreviewError UNSUPPORTED_EXTENSION
```
    The file extension is not supported preview generation.
  - UNSUPPORTED_CONTENT
```
public static final PreviewError UNSUPPORTED_CONTENT
```
    The file content is not supported for preview generation.
- Method Detail
  - tag
```
public 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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this PreviewError.
    
    Returns:
    
    the tag for this instance.
  - isPath
```
public boolean isPath()
```
    Returns true if this instance has the tag PreviewError.Tag.PATH, false otherwise.
    
    Returns:
    
    true if this instance is tagged as PreviewError.Tag.PATH, false otherwise.
  - path
```
public static PreviewError path(LookupError value)
```
    Returns an instance of PreviewError that has its tag set to PreviewError.Tag.PATH.
    An error occurs when downloading metadata for the file.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of PreviewError with its tag set to PreviewError.Tag.PATH.
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is null.
  - getPathValue
```
public LookupError getPathValue()
```
    An error occurs when downloading metadata for the file.
    This instance must be tagged as PreviewError.Tag.PATH.
    
    Returns:
    
    The LookupError value associated with this instance if isPath() is true.
    
    Throws:
    
    java.lang.IllegalStateException - If isPath() is false.
  - isInProgress
```
public boolean isInProgress()
```
    Returns true if this instance has the tag PreviewError.Tag.IN_PROGRESS, false otherwise.
    
    Returns:
    
    true if this instance is tagged as PreviewError.Tag.IN_PROGRESS, false otherwise.
  - isUnsupportedExtension
```
public boolean isUnsupportedExtension()
```
    Returns true if this instance has the tag PreviewError.Tag.UNSUPPORTED_EXTENSION, false otherwise.
    
    Returns:
    
    true if this instance is tagged as PreviewError.Tag.UNSUPPORTED_EXTENSION, false otherwise.
  - isUnsupportedContent
```
public boolean isUnsupportedContent()
```
    Returns true if this instance has the tag PreviewError.Tag.UNSUPPORTED_CONTENT, false otherwise.
    
    Returns:
    
    true if this instance is tagged as PreviewError.Tag.UNSUPPORTED_CONTENT, false otherwise.
  - 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

Class PreviewError

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IN_PROGRESS

UNSUPPORTED_EXTENSION

UNSUPPORTED_CONTENT

Method Detail

tag

isPath

path

getPathValue

isInProgress

isUnsupportedExtension

isUnsupportedContent

hashCode

equals

toString

toStringMultiline