Class TemplateFilterBase
- java.lang.Object
-
- com.dropbox.core.v2.fileproperties.TemplateFilterBase
-
public final class TemplateFilterBase 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
TemplateFilterBase.Serializer
For internal use only.static class
TemplateFilterBase.Tag
Discriminating tag type forTemplateFilterBase
.
-
Field Summary
Fields Modifier and Type Field Description static TemplateFilterBase
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 TemplateFilterBase
filterSome(java.util.List<java.lang.String> value)
Returns an instance ofTemplateFilterBase
that has its tag set toTemplateFilterBase.Tag.FILTER_SOME
.java.util.List<java.lang.String>
getFilterSomeValue()
Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).int
hashCode()
boolean
isFilterSome()
boolean
isOther()
TemplateFilterBase.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 TemplateFilterBase 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 TemplateFilterBase.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 thisTemplateFilterBase
.If a tag returned by the server is unrecognized by this SDK, the
TemplateFilterBase.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isFilterSome
public boolean isFilterSome()
- Returns:
true
if this instance is tagged asTemplateFilterBase.Tag.FILTER_SOME
,false
otherwise.
-
filterSome
public static TemplateFilterBase filterSome(java.util.List<java.lang.String> value)
Returns an instance ofTemplateFilterBase
that has its tag set toTemplateFilterBase.Tag.FILTER_SOME
.Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
TemplateFilterBase
with its tag set toTemplateFilterBase.Tag.FILTER_SOME
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
has fewer than 1 items, contains anull
item, or isnull
.
-
getFilterSomeValue
public java.util.List<java.lang.String> getFilterSomeValue()
Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).This instance must be tagged as
TemplateFilterBase.Tag.FILTER_SOME
.- Returns:
- The
List
value associated with this instance ifisFilterSome()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisFilterSome()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asTemplateFilterBase.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
-
-