Class LinkExpiry
- java.lang.Object
-
- com.dropbox.core.v2.sharing.LinkExpiry
-
public final class LinkExpiry 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 classLinkExpiry.TagDiscriminating tag type forLinkExpiry.
-
Field Summary
Fields Modifier and Type Field Description static LinkExpiryOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static LinkExpiryREMOVE_EXPIRYRemove the currently set expiry for the link.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)java.util.DategetSetExpiryValue()Set a new expiry or change an existing expiry.inthashCode()booleanisOther()booleanisRemoveExpiry()booleanisSetExpiry()static LinkExpirysetExpiry(java.util.Date value)Returns an instance ofLinkExpirythat has its tag set toLinkExpiry.Tag.SET_EXPIRY.LinkExpiry.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_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 returntrue. Callers are recommended to use the tag value in aswitchstatement to properly handle the different values for thisLinkExpiry.If a tag returned by the server is unrecognized by this SDK, the
LinkExpiry.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isRemoveExpiry
public boolean isRemoveExpiry()
- Returns:
trueif this instance is tagged asLinkExpiry.Tag.REMOVE_EXPIRY,falseotherwise.
-
isSetExpiry
public boolean isSetExpiry()
- Returns:
trueif this instance is tagged asLinkExpiry.Tag.SET_EXPIRY,falseotherwise.
-
setExpiry
public static LinkExpiry setExpiry(java.util.Date value)
Returns an instance ofLinkExpirythat has its tag set toLinkExpiry.Tag.SET_EXPIRY.Set a new expiry or change an existing expiry.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
LinkExpirywith its tag set toLinkExpiry.Tag.SET_EXPIRY. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
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
Datevalue associated with this instance ifisSetExpiry()istrue. - Throws:
java.lang.IllegalStateException- IfisSetExpiry()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asLinkExpiry.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
-
-