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 SummaryNested Classes Modifier and Type Class Description static classFileLockContent.TagDiscriminating tag type forFileLockContent.
 - 
Field SummaryFields 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 SummaryAll 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- 
UNLOCKEDpublic static final FileLockContent UNLOCKED Empty type to indicate no lock.
 - 
OTHERpublic 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- 
tagpublic 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.
 
 - 
isUnlockedpublic boolean isUnlocked() - Returns:
- trueif this instance is tagged as- FileLockContent.Tag.UNLOCKED,- falseotherwise.
 
 - 
isSingleUserpublic boolean isSingleUser() - Returns:
- trueif this instance is tagged as- FileLockContent.Tag.SINGLE_USER,- falseotherwise.
 
 - 
singleUserpublic 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- if- valueis- null.
 
 - 
getSingleUserValuepublic 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- If- isSingleUser()is- false.
 
 - 
isOtherpublic boolean isOther() - Returns:
- trueif this instance is tagged as- FileLockContent.Tag.OTHER,- falseotherwise.
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- java.lang.Object
 
 - 
equalspublic boolean equals(java.lang.Object obj) - Overrides:
- equalsin class- java.lang.Object
 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 - 
toStringMultilinepublic 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
 
 
- 
 
-