Package com.dropbox.core.v2.files

Class TagObject

java.lang.Object

com.dropbox.core.v2.files.TagObject

public final class TagObject
extends java.lang.Object

Tag that can be added in multiple ways.

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

Field Summary

Fields

Modifier and Type	Field	Description
static TagObject	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)
UserGeneratedTag	getUserGeneratedTagValue()	Tag generated by the user.
int	hashCode()
boolean	isOther()	Returns true if this instance has the tag TagObject.Tag.OTHER, false otherwise.
boolean	isUserGeneratedTag()	Returns true if this instance has the tag TagObject.Tag.USER_GENERATED_TAG, false otherwise.
TagObject.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.
static TagObject	userGeneratedTag(UserGeneratedTag value)	Returns an instance of TagObject that has its tag set to TagObject.Tag.USER_GENERATED_TAG.

Methods inherited from class java.lang.Object

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

Field Detail

OTHER

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

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

Returns:

the tag for this instance.

isUserGeneratedTag

public boolean isUserGeneratedTag()

Returns true if this instance has the tag TagObject.Tag.USER_GENERATED_TAG, false otherwise.

Returns:

true if this instance is tagged as TagObject.Tag.USER_GENERATED_TAG, false otherwise.

userGeneratedTag

public static TagObject userGeneratedTag(UserGeneratedTag value)

Returns an instance of TagObject that has its tag set to TagObject.Tag.USER_GENERATED_TAG.

Tag generated by the user.

Parameters:

value - value to assign to this instance.

Returns:

Instance of TagObject with its tag set to TagObject.Tag.USER_GENERATED_TAG.

Throws:

java.lang.IllegalArgumentException - if value is null.

getUserGeneratedTagValue

public UserGeneratedTag getUserGeneratedTagValue()

Tag generated by the user.

This instance must be tagged as TagObject.Tag.USER_GENERATED_TAG.

Returns:

The UserGeneratedTag value associated with this instance if isUserGeneratedTag() is true.

Throws:

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

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as TagObject.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