public final class TemplateFilter
extends java.lang.Object
isAbc()
methods will
return true
. You can use tag()
to determine the tag
associated with this instance.Modifier and Type | Class and Description |
---|---|
static class |
TemplateFilter.Tag
Discriminating tag type for
TemplateFilter . |
Modifier and Type | Field and Description |
---|---|
static TemplateFilter |
FILTER_NONE
No templates will be filtered from the result (all templates will be
returned).
|
static TemplateFilter |
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
static TemplateFilter |
filterSome(java.util.List<java.lang.String> value)
Returns an instance of
TemplateFilter that has its tag set to
TemplateFilter.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 |
isFilterNone()
|
boolean |
isFilterSome()
|
boolean |
isOther()
|
TemplateFilter.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.
|
public static final TemplateFilter OTHER
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.
public static final TemplateFilter FILTER_NONE
public TemplateFilter.Tag tag()
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 TemplateFilter
.
public boolean isFilterSome()
true
if this instance is tagged as TemplateFilter.Tag.FILTER_SOME
, false
otherwise.public static TemplateFilter filterSome(java.util.List<java.lang.String> value)
TemplateFilter
that has its tag set to
TemplateFilter.Tag.FILTER_SOME
.
Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).
value
- value to assign to this instance.TemplateFilter
with its tag set to TemplateFilter.Tag.FILTER_SOME
.java.lang.IllegalArgumentException
- if value
has fewer than 1
items, contains a null
item, or is null
.public java.util.List<java.lang.String> getFilterSomeValue()
This instance must be tagged as TemplateFilter.Tag.FILTER_SOME
.
List
value associated with this instance if isFilterSome()
is true
.java.lang.IllegalStateException
- If isFilterSome()
is false
.public boolean isOther()
true
if this instance is tagged as TemplateFilter.Tag.OTHER
,
false
otherwise.public boolean isFilterNone()
true
if this instance is tagged as TemplateFilter.Tag.FILTER_NONE
, false
otherwise.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toStringMultiline()
The returned String may contain newlines.