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 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
TagObject.Tag
Discriminating tag type forTagObject
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
UserGeneratedTag
getUserGeneratedTagValue()
Tag generated by the user.int
hashCode()
boolean
isOther()
boolean
isUserGeneratedTag()
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 ofTagObject
that has its tag set toTagObject.Tag.USER_GENERATED_TAG
.
-
-
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisTagObject
.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 is tagged asTagObject.Tag.USER_GENERATED_TAG
,false
otherwise.
-
userGeneratedTag
public static TagObject userGeneratedTag(UserGeneratedTag value)
Returns an instance ofTagObject
that has its tag set toTagObject.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 toTagObject.Tag.USER_GENERATED_TAG
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisUserGeneratedTag()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisUserGeneratedTag()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asTagObject.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
-
-