Package com.dropbox.core.v2.users

Class UserFeatureValue

java.lang.Object

com.dropbox.core.v2.users.UserFeatureValue

public final class UserFeatureValue
extends java.lang.Object

Values that correspond to entries in UserFeature.

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 class	UserFeatureValue.Tag	Discriminating tag type for UserFeatureValue.

Field Summary

Fields

Modifier and Type	Field	Description
static UserFeatureValue	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static UserFeatureValue	fileLocking(FileLockingValue value)	Returns an instance of UserFeatureValue that has its tag set to UserFeatureValue.Tag.FILE_LOCKING.
FileLockingValue	getFileLockingValue()	This instance must be tagged as UserFeatureValue.Tag.FILE_LOCKING.
PaperAsFilesValue	getPaperAsFilesValue()	This instance must be tagged as UserFeatureValue.Tag.PAPER_AS_FILES.
int	hashCode()
boolean	isFileLocking()	Returns true if this instance has the tag UserFeatureValue.Tag.FILE_LOCKING, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UserFeatureValue.Tag.OTHER, false otherwise.
boolean	isPaperAsFiles()	Returns true if this instance has the tag UserFeatureValue.Tag.PAPER_AS_FILES, false otherwise.
static UserFeatureValue	paperAsFiles(PaperAsFilesValue value)	Returns an instance of UserFeatureValue that has its tag set to UserFeatureValue.Tag.PAPER_AS_FILES.
UserFeatureValue.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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OTHER

public static final UserFeatureValue 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 UserFeatureValue.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 UserFeatureValue.

If a tag returned by the server is unrecognized by this SDK, the UserFeatureValue.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isPaperAsFiles

public boolean isPaperAsFiles()

Returns true if this instance has the tag UserFeatureValue.Tag.PAPER_AS_FILES, false otherwise.

Returns:

true if this instance is tagged as UserFeatureValue.Tag.PAPER_AS_FILES, false otherwise.

paperAsFiles

public static UserFeatureValue paperAsFiles(PaperAsFilesValue value)

Returns an instance of UserFeatureValue that has its tag set to UserFeatureValue.Tag.PAPER_AS_FILES.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of UserFeatureValue with its tag set to UserFeatureValue.Tag.PAPER_AS_FILES.

Throws:

java.lang.IllegalArgumentException - if value is null.

getPaperAsFilesValue

public PaperAsFilesValue getPaperAsFilesValue()

This instance must be tagged as UserFeatureValue.Tag.PAPER_AS_FILES.

Returns:

The PaperAsFilesValue value associated with this instance if isPaperAsFiles() is true.

Throws:

java.lang.IllegalStateException - If isPaperAsFiles() is false.

isFileLocking

public boolean isFileLocking()

Returns true if this instance has the tag UserFeatureValue.Tag.FILE_LOCKING, false otherwise.

Returns:

true if this instance is tagged as UserFeatureValue.Tag.FILE_LOCKING, false otherwise.

fileLocking

public static UserFeatureValue fileLocking(FileLockingValue value)

Returns an instance of UserFeatureValue that has its tag set to UserFeatureValue.Tag.FILE_LOCKING.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of UserFeatureValue with its tag set to UserFeatureValue.Tag.FILE_LOCKING.

Throws:

java.lang.IllegalArgumentException - if value is null.

getFileLockingValue

public FileLockingValue getFileLockingValue()

This instance must be tagged as UserFeatureValue.Tag.FILE_LOCKING.

Returns:

The FileLockingValue value associated with this instance if isFileLocking() is true.

Throws:

java.lang.IllegalStateException - If isFileLocking() is false.

isOther

public boolean isOther()

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

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.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