com.dropbox.core.v2.sharing

Class LinkPassword

java.lang.Object

com.dropbox.core.v2.sharing.LinkPassword

public final class LinkPassword
extends java.lang.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LinkPassword.Tag Discriminating tag type for LinkPassword.

Field Summary

Fields

Modifier and Type	Field and Description
static LinkPassword	OTHER Catch-all used for unknown tag values returned by the Dropbox servers.
static LinkPassword	REMOVE_PASSWORD Remove the currently set password for the link.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getSetPasswordValue() Set a new password or change an existing password.
int	hashCode()
boolean	isOther() Returns true if this instance has the tag LinkPassword.Tag.OTHER, false otherwise.
boolean	isRemovePassword() Returns true if this instance has the tag LinkPassword.Tag.REMOVE_PASSWORD, false otherwise.
boolean	isSetPassword() Returns true if this instance has the tag LinkPassword.Tag.SET_PASSWORD, false otherwise.
static LinkPassword	setPassword(java.lang.String value) Returns an instance of LinkPassword that has its tag set to LinkPassword.Tag.SET_PASSWORD.
LinkPassword.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

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 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(java.lang.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:

java.lang.IllegalArgumentException - if value is null.

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 String value associated with this instance if isSetPassword() is true.

Throws:

java.lang.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 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