Package com.dropbox.core.v2.files

Class ExportError

java.lang.Object
com.dropbox.core.v2.files.ExportError
public final class ExportError extends Object
This class is an open 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.

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.

  • Field Details

    • NON_EXPORTABLE

      public static final ExportError NON_EXPORTABLE
      This file type cannot be exported. Use DbxUserFilesRequests.download(String,String) instead.

    • INVALID_EXPORT_FORMAT

      public static final ExportError INVALID_EXPORT_FORMAT
      The specified export format is not a valid option for this file type.

    • RETRY_ERROR

      public static final ExportError RETRY_ERROR
      The exportable content is not yet available. Please retry later.

    • OTHER

      public static final ExportError 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 Details

    • tag

      public ExportError.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 ExportError.

      If a tag returned by the server is unrecognized by this SDK, the ExportError.Tag.OTHER value will be used.

      Returns:
      the tag for this instance.

    • isPath

      public boolean isPath()
      Returns true if this instance has the tag ExportError.Tag.PATH, false otherwise.
      Returns:
      true if this instance is tagged as ExportError.Tag.PATH, false otherwise.

    • path

      public static ExportError path(LookupError value)
      Returns an instance of ExportError that has its tag set to ExportError.Tag.PATH.

      None

      Parameters:
      value - value to assign to this instance.
      Returns:
      Instance of ExportError with its tag set to ExportError.Tag.PATH.
      Throws:
      IllegalArgumentException - if value is null.

    • getPathValue

      public LookupError getPathValue()
      This instance must be tagged as ExportError.Tag.PATH.
      Returns:
      The LookupError value associated with this instance if isPath() is true.
      Throws:
      IllegalStateException - If isPath() is false.

    • isNonExportable

      public boolean isNonExportable()
      Returns true if this instance has the tag ExportError.Tag.NON_EXPORTABLE, false otherwise.
      Returns:
      true if this instance is tagged as ExportError.Tag.NON_EXPORTABLE, false otherwise.

    • isInvalidExportFormat

      public boolean isInvalidExportFormat()
      Returns true if this instance has the tag ExportError.Tag.INVALID_EXPORT_FORMAT, false otherwise.
      Returns:
      true if this instance is tagged as ExportError.Tag.INVALID_EXPORT_FORMAT, false otherwise.

    • isRetryError

      public boolean isRetryError()
      Returns true if this instance has the tag ExportError.Tag.RETRY_ERROR, false otherwise.
      Returns:
      true if this instance is tagged as ExportError.Tag.RETRY_ERROR, false otherwise.

    • isOther

      public boolean isOther()
      Returns true if this instance has the tag ExportError.Tag.OTHER, false otherwise.
      Returns:
      true if this instance is tagged as ExportError.Tag.OTHER, false otherwise.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toStringMultiline

      public 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