Package com.dropbox.core.v2.files

Class FileLockContent

java.lang.Object

com.dropbox.core.v2.files.FileLockContent

public final class FileLockContent
extends 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	Description
static enum	FileLockContent.Tag	Discriminating tag type for FileLockContent.

Field Summary

Fields

Modifier and Type	Field	Description
static final FileLockContent	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final FileLockContent	UNLOCKED	Empty type to indicate no lock.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
SingleUserLock	getSingleUserValue()	A lock held by a single user.
int	hashCode()
boolean	isOther()	Returns true if this instance has the tag FileLockContent.Tag.OTHER, false otherwise.
boolean	isSingleUser()	Returns true if this instance has the tag FileLockContent.Tag.SINGLE_USER, false otherwise.
boolean	isUnlocked()	Returns true if this instance has the tag FileLockContent.Tag.UNLOCKED, false otherwise.
static FileLockContent	singleUser(SingleUserLock value)	Returns an instance of FileLockContent that has its tag set to FileLockContent.Tag.SINGLE_USER.
FileLockContent.Tag	tag()	Returns the tag for this instance.
String	toString()
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 Details

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 Details

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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this FileLockContent.

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 has the tag FileLockContent.Tag.UNLOCKED, false otherwise.

Returns:

true if this instance is tagged as FileLockContent.Tag.UNLOCKED, false otherwise.

isSingleUser

public boolean isSingleUser()

Returns true if this instance has the tag FileLockContent.Tag.SINGLE_USER, false otherwise.

Returns:

true if this instance is tagged as FileLockContent.Tag.SINGLE_USER, false otherwise.

singleUser

public static FileLockContent singleUser(SingleUserLock value)

Returns an instance of FileLockContent that has its tag set to FileLockContent.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 to FileLockContent.Tag.SINGLE_USER.

Throws:

IllegalArgumentException - if value is null.

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 if isSingleUser() is true.

Throws:

IllegalStateException - If isSingleUser() is false.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as FileLockContent.Tag.OTHER, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public 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