com.vaadin.flow.templatemodel

Class PropertyFilter

java.lang.Object

com.vaadin.flow.templatemodel.PropertyFilter

All Implemented Interfaces:

Predicate<String>

public class PropertyFilter
extends Object
implements Predicate<String>

Property name filter that supports composition for resolving sub properties.

Since:

1.0

Author:

Vaadin Ltd

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyFilter	ACCEPT_ALL An unwrapped filter that accepts all property names.

Constructor Summary

Constructors

Constructor and Description
PropertyFilter(Predicate<String> predicate) Creates a new unwrapped filter from the given predicate.
PropertyFilter(PropertyFilter outerFilter, String scopeName) Creates a new filter by adapting a filter from an outer scope.
PropertyFilter(PropertyFilter outerFilter, String scopeName, Predicate<String> predicate) Creates a new filter by combining a predicate with a filter for an outer scope.

Method Summary

Modifier and Type	Method and Description
String	getPrefix() Get the full path prefix of this property filter.
boolean	test(String propertyName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Field Detail

ACCEPT_ALL

public static final PropertyFilter ACCEPT_ALL

An unwrapped filter that accepts all property names.

Constructor Detail

PropertyFilter

public PropertyFilter(Predicate<String> predicate)

Creates a new unwrapped filter from the given predicate.

Parameters:

predicate - the predicate to use for this filter, not null

PropertyFilter

public PropertyFilter(PropertyFilter outerFilter,
                      String scopeName,
                      Predicate<String> predicate)

Creates a new filter by combining a predicate with a filter for an outer scope.

Parameters:

outerFilter - the filter of the outer scope, not null

scopeName - the name used in the outer filter when referencing properties in the inner scope, not null

predicate - a predicate matching property names in the inner scope

PropertyFilter

public PropertyFilter(PropertyFilter outerFilter,
                      String scopeName)

Creates a new filter by adapting a filter from an outer scope.

Parameters:

outerFilter - the filter of the outer scope, not null

scopeName - the name used in the outer filter when referencing properties in the inner scope, not null

Method Detail

test

public boolean test(String propertyName)

Specified by:

test in interface Predicate<String>

getPrefix

public String getPrefix()

Get the full path prefix of this property filter. The prefix is accumulated when constructing new property filters from outer filters and scope names.

Returns:

the prefix string of this filter