Package com.dropbox.core.v2.files

Class SaveUrlError

java.lang.Object
com.dropbox.core.v2.files.SaveUrlError
public final class SaveUrlError 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

    • DOWNLOAD_FAILED

      public static final SaveUrlError DOWNLOAD_FAILED
      Failed downloading the given URL. The URL may be password-protected and the password provided was incorrect, or the link may be disabled.

    • INVALID_URL

      public static final SaveUrlError INVALID_URL
      The given URL is invalid.

    • NOT_FOUND

      public static final SaveUrlError NOT_FOUND
      The file where the URL is saved to no longer exists.

    • OTHER

      public static final SaveUrlError 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 SaveUrlError.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 SaveUrlError.

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

      Returns:
      the tag for this instance.

    • isPath

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

    • path

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

      None

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

    • getPathValue

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

    • isDownloadFailed

      public boolean isDownloadFailed()
      Returns true if this instance has the tag SaveUrlError.Tag.DOWNLOAD_FAILED, false otherwise.
      Returns:
      true if this instance is tagged as SaveUrlError.Tag.DOWNLOAD_FAILED, false otherwise.

    • isInvalidUrl

      public boolean isInvalidUrl()
      Returns true if this instance has the tag SaveUrlError.Tag.INVALID_URL, false otherwise.
      Returns:
      true if this instance is tagged as SaveUrlError.Tag.INVALID_URL, false otherwise.

    • isNotFound

      public boolean isNotFound()
      Returns true if this instance has the tag SaveUrlError.Tag.NOT_FOUND, false otherwise.
      Returns:
      true if this instance is tagged as SaveUrlError.Tag.NOT_FOUND, false otherwise.

    • isOther

      public boolean isOther()
      Returns true if this instance has the tag SaveUrlError.Tag.OTHER, false otherwise.
      Returns:
      true if this instance is tagged as SaveUrlError.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