Class FileLockContent
- java.lang.Object
-
- com.dropbox.core.v2.files.FileLockContent
-
public final class FileLockContent 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 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
OTHER
value will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FileLockContent.Tag
Discriminating tag type forFileLockContent
.
-
Field Summary
Fields Modifier and Type Field Description static FileLockContent
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static FileLockContent
UNLOCKED
Empty type to indicate no lock.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
SingleUserLock
getSingleUserValue()
A lock held by a single user.int
hashCode()
boolean
isOther()
boolean
isSingleUser()
boolean
isUnlocked()
static FileLockContent
singleUser(SingleUserLock value)
Returns an instance ofFileLockContent
that has its tag set toFileLockContent.Tag.SINGLE_USER
.FileLockContent.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.
-
-
-
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 aswitch
statement to properly handle the different values for thisFileLockContent
.If a tag returned by the server is unrecognized by this SDK, the
FileLockContent.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isUnlocked
public boolean isUnlocked()
- Returns:
true
if this instance is tagged asFileLockContent.Tag.UNLOCKED
,false
otherwise.
-
isSingleUser
public boolean isSingleUser()
- Returns:
true
if this instance is tagged asFileLockContent.Tag.SINGLE_USER
,false
otherwise.
-
singleUser
public static FileLockContent singleUser(SingleUserLock value)
Returns an instance ofFileLockContent
that 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
FileLockContent
with its tag set toFileLockContent.Tag.SINGLE_USER
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getSingleUserValue
public SingleUserLock getSingleUserValue()
A lock held by a single user.This instance must be tagged as
FileLockContent.Tag.SINGLE_USER
.- Returns:
- The
SingleUserLock
value associated with this instance ifisSingleUser()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisSingleUser()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asFileLockContent.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in 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
-
-