Class PropertiesSearchMode
- java.lang.Object
-
- com.dropbox.core.v2.fileproperties.PropertiesSearchMode
-
public final class PropertiesSearchMode 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
PropertiesSearchMode.Tag
Discriminating tag type forPropertiesSearchMode
.
-
Field Summary
Fields Modifier and Type Field Description static PropertiesSearchMode
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static PropertiesSearchMode
fieldName(java.lang.String value)
Returns an instance ofPropertiesSearchMode
that has its tag set toPropertiesSearchMode.Tag.FIELD_NAME
.java.lang.String
getFieldNameValue()
Search for a value associated with this field name.int
hashCode()
boolean
isFieldName()
boolean
isOther()
PropertiesSearchMode.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
-
OTHER
public static final PropertiesSearchMode 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 PropertiesSearchMode.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 thisPropertiesSearchMode
.If a tag returned by the server is unrecognized by this SDK, the
PropertiesSearchMode.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isFieldName
public boolean isFieldName()
- Returns:
true
if this instance is tagged asPropertiesSearchMode.Tag.FIELD_NAME
,false
otherwise.
-
fieldName
public static PropertiesSearchMode fieldName(java.lang.String value)
Returns an instance ofPropertiesSearchMode
that has its tag set toPropertiesSearchMode.Tag.FIELD_NAME
.Search for a value associated with this field name.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
PropertiesSearchMode
with its tag set toPropertiesSearchMode.Tag.FIELD_NAME
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getFieldNameValue
public java.lang.String getFieldNameValue()
Search for a value associated with this field name.This instance must be tagged as
PropertiesSearchMode.Tag.FIELD_NAME
.- Returns:
- The
String
value associated with this instance ifisFieldName()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisFieldName()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asPropertiesSearchMode.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
-
-