com.dropbox.core.v2.sharing

Class LinkExpiry

java.lang.Object

com.dropbox.core.v2.sharing.LinkExpiry

public final class LinkExpiry
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	LinkExpiry.Tag Discriminating tag type for LinkExpiry.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Date	getSetExpiryValue() Set a new expiry or change an existing expiry.
int	hashCode()
boolean	isOther() Returns true if this instance has the tag LinkExpiry.Tag.OTHER, false otherwise.
boolean	isRemoveExpiry() Returns true if this instance has the tag LinkExpiry.Tag.REMOVE_EXPIRY, false otherwise.
boolean	isSetExpiry() Returns true if this instance has the tag LinkExpiry.Tag.SET_EXPIRY, false otherwise.
static LinkExpiry	setExpiry(java.util.Date value) Returns an instance of LinkExpiry that has its tag set to LinkExpiry.Tag.SET_EXPIRY.
LinkExpiry.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_EXPIRY

public static final LinkExpiry REMOVE_EXPIRY

Remove the currently set expiry for the link.

OTHER

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

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

Returns:

the tag for this instance.

isRemoveExpiry

public boolean isRemoveExpiry()

Returns true if this instance has the tag LinkExpiry.Tag.REMOVE_EXPIRY, false otherwise.

Returns:

true if this instance is tagged as LinkExpiry.Tag.REMOVE_EXPIRY, false otherwise.

isSetExpiry

public boolean isSetExpiry()

Returns true if this instance has the tag LinkExpiry.Tag.SET_EXPIRY, false otherwise.

Returns:

true if this instance is tagged as LinkExpiry.Tag.SET_EXPIRY, false otherwise.

setExpiry

public static LinkExpiry setExpiry(java.util.Date value)

Returns an instance of LinkExpiry that has its tag set to LinkExpiry.Tag.SET_EXPIRY.

Set a new expiry or change an existing expiry.

Parameters:

value - value to assign to this instance.

Returns:

Instance of LinkExpiry with its tag set to LinkExpiry.Tag.SET_EXPIRY.

Throws:

java.lang.IllegalArgumentException - if value is null.

getSetExpiryValue

public java.util.Date getSetExpiryValue()

Set a new expiry or change an existing expiry.

This instance must be tagged as LinkExpiry.Tag.SET_EXPIRY.

Returns:

The Date value associated with this instance if isSetExpiry() is true.

Throws:

java.lang.IllegalStateException - If isSetExpiry() is false.

isOther

public boolean isOther()

Returns true if this instance has the tag LinkExpiry.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as LinkExpiry.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