Class FileLockContent
- java.lang.Object
-
- com.dropbox.core.v2.files.FileLockContent
-
public final class FileLockContent 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 classFileLockContent.TagDiscriminating tag type forFileLockContent.
-
Field Summary
Fields Modifier and Type Field Description static FileLockContentOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static FileLockContentUNLOCKEDEmpty type to indicate no lock.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)SingleUserLockgetSingleUserValue()A lock held by a single user.inthashCode()booleanisOther()booleanisSingleUser()booleanisUnlocked()static FileLockContentsingleUser(SingleUserLock value)Returns an instance ofFileLockContentthat has its tag set toFileLockContent.Tag.SINGLE_USER.FileLockContent.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
-
UNLOCKED
public static final FileLockContent UNLOCKED
Empty type to indicate no lock.
-
OTHER
public static final FileLockContent 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 FileLockContent.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 thisFileLockContent.If a tag returned by the server is unrecognized by this SDK, the
FileLockContent.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isUnlocked
public boolean isUnlocked()
- Returns:
trueif this instance is tagged asFileLockContent.Tag.UNLOCKED,falseotherwise.
-
isSingleUser
public boolean isSingleUser()
- Returns:
trueif this instance is tagged asFileLockContent.Tag.SINGLE_USER,falseotherwise.
-
singleUser
public static FileLockContent singleUser(SingleUserLock value)
Returns an instance ofFileLockContentthat has its tag set toFileLockContent.Tag.SINGLE_USER.A lock held by a single user.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
FileLockContentwith its tag set toFileLockContent.Tag.SINGLE_USER. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getSingleUserValue
public SingleUserLock getSingleUserValue()
A lock held by a single user.This instance must be tagged as
FileLockContent.Tag.SINGLE_USER.- Returns:
- The
SingleUserLockvalue associated with this instance ifisSingleUser()istrue. - Throws:
java.lang.IllegalStateException- IfisSingleUser()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asFileLockContent.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
-
-