Package com.dropbox.core.v2.fileproperties

Class TemplateFilter

java.lang.Object

com.dropbox.core.v2.fileproperties.TemplateFilter

public final class TemplateFilter
extends java.lang.Object

This class is a 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplateFilter.Tag	Discriminating tag type for TemplateFilter.

Field Summary

Fields

Modifier and Type	Field	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.

Method Summary

Modifier and Type	Method	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()	Returns true if this instance has the tag TemplateFilter.Tag.FILTER_NONE, false otherwise.
boolean	isFilterSome()	Returns true if this instance has the tag TemplateFilter.Tag.FILTER_SOME, false otherwise.
boolean	isOther()	Returns true if this instance has the tag TemplateFilter.Tag.OTHER, false otherwise.
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.

Methods inherited from class java.lang.Object

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

Field Detail

OTHER

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

FILTER_NONE

public static final TemplateFilter FILTER_NONE

No templates will be filtered from the result (all templates will be returned).

Method Detail

tag

public TemplateFilter.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 TemplateFilter.

Returns:

the tag for this instance.

isFilterSome

public boolean isFilterSome()

Returns true if this instance has the tag TemplateFilter.Tag.FILTER_SOME, false otherwise.

Returns:

true if this instance is tagged as TemplateFilter.Tag.FILTER_SOME, false otherwise.

filterSome

public 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.

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 TemplateFilter with its tag set to TemplateFilter.Tag.FILTER_SOME.

Throws:

java.lang.IllegalArgumentException - if value has fewer than 1 items, contains a null item, or is null.

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 TemplateFilter.Tag.FILTER_SOME.

Returns:

The List value associated with this instance if isFilterSome() is true.

Throws:

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

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as TemplateFilter.Tag.OTHER, false otherwise.

isFilterNone

public boolean isFilterNone()

Returns true if this instance has the tag TemplateFilter.Tag.FILTER_NONE, false otherwise.

Returns:

true if this instance is tagged as TemplateFilter.Tag.FILTER_NONE, 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