Package org.openhab.core.persistence.filter

Class PersistenceIncludeFilter

java.lang.Object

org.openhab.core.persistence.filter.PersistenceFilter

org.openhab.core.persistence.filter.PersistenceIncludeFilter

@NonNullByDefault
public class PersistenceIncludeFilter
extends PersistenceFilter

The PersistenceIncludeFilter is a filter that allows only specific values to pass

The filter returns false if the string representation of the item's state is not in the given list

Author:

Jan N. Klug - Initial contribution

Constructor Summary

Constructors

Constructor	Description
PersistenceIncludeFilter(String name, BigDecimal lower, BigDecimal upper, @Nullable String unit, @Nullable Boolean inverted)

Method Summary

Modifier and Type	Method	Description
boolean	apply(Item item)	Apply this filter to an item
boolean	getInverted()
BigDecimal	getLower()
String	getUnit()
BigDecimal	getUpper()
void	persisted(Item item)	Notify filter that item was persisted
String	toString()

Methods inherited from class org.openhab.core.persistence.filter.PersistenceFilter

equals, getName, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

PersistenceIncludeFilter

public PersistenceIncludeFilter(String name,
 BigDecimal lower,
 BigDecimal upper,
 @Nullable String unit,
 @Nullable Boolean inverted)

Method Details

getLower

public BigDecimal getLower()

getUpper

public BigDecimal getUpper()

getUnit

public String getUnit()

getInverted

public boolean getInverted()

apply

public boolean apply(Item item)

Description copied from class: PersistenceFilter

Apply this filter to an item

Specified by:

apply in class PersistenceFilter

Parameters:

item - the item to check

Returns:

true if the filter allows persisting this value

persisted

public void persisted(Item item)

Description copied from class: PersistenceFilter

Notify filter that item was persisted

Specified by:

persisted in class PersistenceFilter

Parameters:

item - the persisted item

toString

public String toString()

Overrides:

toString in class PersistenceFilter