Package com.dropbox.core.v2.sharing

Class LinkPassword

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

    • REMOVE_PASSWORD

      public static final LinkPassword REMOVE_PASSWORD
      Remove the currently set password for the link.

    • OTHER

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

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

      Returns:
      the tag for this instance.

    • isRemovePassword

      public boolean isRemovePassword()
      Returns true if this instance has the tag LinkPassword.Tag.REMOVE_PASSWORD, false otherwise.
      Returns:
      true if this instance is tagged as LinkPassword.Tag.REMOVE_PASSWORD, false otherwise.

    • isSetPassword

      public boolean isSetPassword()
      Returns true if this instance has the tag LinkPassword.Tag.SET_PASSWORD, false otherwise.
      Returns:
      true if this instance is tagged as LinkPassword.Tag.SET_PASSWORD, false otherwise.

    • setPassword

      public static LinkPassword setPassword(String value)
      Returns an instance of LinkPassword that has its tag set to LinkPassword.Tag.SET_PASSWORD.

      Set a new password or change an existing password.

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

    • getSetPasswordValue

      public String getSetPasswordValue()
      Set a new password or change an existing password.

      This instance must be tagged as LinkPassword.Tag.SET_PASSWORD.

      Returns:
      The String value associated with this instance if isSetPassword() is true.
      Throws:
      IllegalStateException - If isSetPassword() is false.

    • isOther

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