Class LinkPassword
- java.lang.Object
-
- com.dropbox.core.v2.sharing.LinkPassword
-
public final class LinkPassword extends java.lang.ObjectThis class is an open 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.Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classLinkPassword.TagDiscriminating tag type forLinkPassword.
-
Field Summary
Fields Modifier and Type Field Description static LinkPasswordOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static LinkPasswordREMOVE_PASSWORDRemove the currently set password for the link.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)java.lang.StringgetSetPasswordValue()Set a new password or change an existing password.inthashCode()booleanisOther()booleanisRemovePassword()booleanisSetPassword()static LinkPasswordsetPassword(java.lang.String value)Returns an instance ofLinkPasswordthat has its tag set toLinkPassword.Tag.SET_PASSWORD.LinkPassword.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
-
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 Detail
-
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 returntrue. Callers are recommended to use the tag value in aswitchstatement to properly handle the different values for thisLinkPassword.If a tag returned by the server is unrecognized by this SDK, the
LinkPassword.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isRemovePassword
public boolean isRemovePassword()
- Returns:
trueif this instance is tagged asLinkPassword.Tag.REMOVE_PASSWORD,falseotherwise.
-
isSetPassword
public boolean isSetPassword()
- Returns:
trueif this instance is tagged asLinkPassword.Tag.SET_PASSWORD,falseotherwise.
-
setPassword
public static LinkPassword setPassword(java.lang.String value)
Returns an instance ofLinkPasswordthat has its tag set toLinkPassword.Tag.SET_PASSWORD.Set a new password or change an existing password.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
LinkPasswordwith its tag set toLinkPassword.Tag.SET_PASSWORD. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getSetPasswordValue
public java.lang.String getSetPasswordValue()
Set a new password or change an existing password.This instance must be tagged as
LinkPassword.Tag.SET_PASSWORD.- Returns:
- The
Stringvalue associated with this instance ifisSetPassword()istrue. - Throws:
java.lang.IllegalStateException- IfisSetPassword()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asLinkPassword.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.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
-
-