org.onosproject.incubator.elasticcfg

Interface ConfigFilter

public interface ConfigFilter

Abstraction for Filters that can be used while traversing the PropConfig stores. This abstraction allows to select entries of interest based on various criteria defined by this interface. Only criteria based on ConfigNodePath are supported currently. Filters can be used with "GET" methods of ProprietaryConfigService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConfigFilter.Builder Builder for ConfigFilter.

Method Summary

Modifier and Type	Method and Description
java.util.Set<ConfigNodePath>	getCriteria() Method to list all the ConfigNodePath criteria that are in place for a ConfigFilter.
boolean	isEmptyFilter() Method to check if the ConfigFilter has an empty criteria set.
ConfigFilter	negateFilter(ConfigFilter original) Method to create a filter that include all entries rejected by the criteria.

Method Detail

getCriteria

java.util.Set<ConfigNodePath> getCriteria()

Method to list all the ConfigNodePath criteria that are in place for a ConfigFilter.

Returns:

Set of ConfigNodePath criteria for this entity

negateFilter

ConfigFilter negateFilter(ConfigFilter original)

Method to create a filter that include all entries rejected by the criteria.

Parameters:

original - filter object with a criteria set

Returns:

ConfigFilter object with negated criteria set

Throws:

InvalidFilterException - if the received ConfigFilter object was null or if it had an empty criteria set

isEmptyFilter

boolean isEmptyFilter()

Method to check if the ConfigFilter has an empty criteria set.

Returns:

true if criteria set is empty, true otherwise.