es.situm.sdk.utils.filter

Class Filter

java.lang.Object

es.situm.sdk.utils.filter.Filter

public class Filter
extends java.lang.Object

Filter a collection of Filterable objects, by name|value of their custom fields.

The filter just stores getFilterMode() and getKeyValueFilters(). You can instance a filter, specifying how to filter, and reuse it to filter multiple collections.

See Also:

FilterMode}, {@link KeyValueFilter}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Filter.FilterMode Operator to concatenate filters in a filters list
static class	Filter.KeyValueFilter Helper class used to filter Map objects.

Constructor Summary

Constructors

Constructor and Description
Filter(Filter.FilterMode filterMode, java.util.Collection<Filter.KeyValueFilter> keyValueFilters)

Method Summary

Modifier and Type	Method and Description
<T extends Filterable> java.util.ArrayList<T>	filter(java.util.Collection<T> toFilter) Filter the passed list of items using the stored filters.
Filter.FilterMode	getFilterMode()
java.util.Collection<Filter.KeyValueFilter>	getKeyValueFilters()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Filter

public Filter(Filter.FilterMode filterMode,
              java.util.Collection<Filter.KeyValueFilter> keyValueFilters)

Parameters:

filterMode - can't be null

keyValueFilters - can't be null

Throws:

java.lang.NullPointerException - if some parameter is null

Method Detail

getKeyValueFilters

public java.util.Collection<Filter.KeyValueFilter> getKeyValueFilters()

getFilterMode

public Filter.FilterMode getFilterMode()

filter

public <T extends Filterable> java.util.ArrayList<T> filter(java.util.Collection<T> toFilter)

Filter the passed list of items using the stored filters.

Parameters:

toFilter - element to filter. Is not altered.

Returns:

new list with the resulting filtered items. Provided list is not altered.

Throws:

java.lang.NullPointerException - if some parameter is null