Package com.vaadin.flow.data.binder

Class PropertyFilterDefinition

java.lang.Object

com.vaadin.flow.data.binder.PropertyFilterDefinition

All Implemented Interfaces:

Serializable

public class PropertyFilterDefinition
extends Object
implements Serializable

Contains the constraints for filtering nested properties.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PropertyFilterDefinition(int maxNestingDepth, List<String> ignorePackageNamesStartingWith)	Create a property filter with max nesting depth and package names to ignore.

Method Summary

Modifier and Type	Method	Description
static PropertyFilterDefinition	getDefaultFilter()	Get the default nested property filtering conditions.
List<String>	getIgnorePackageNamesStartingWith()	Returns a list of package name prefixes to ignore.
int	getMaxNestingDepth()	Returns the maximum amount of nesting levels for sub-properties.

Methods inherited from class java.lang.Object

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

Constructor Details

PropertyFilterDefinition

public PropertyFilterDefinition(int maxNestingDepth,
 List<String> ignorePackageNamesStartingWith)

Create a property filter with max nesting depth and package names to ignore.

Parameters:

maxNestingDepth - The maximum amount of nesting levels for sub-properties.

ignorePackageNamesStartingWith - Ignore package names that start with this string, for example "java.lang".

Method Details

getMaxNestingDepth

public int getMaxNestingDepth()

Returns the maximum amount of nesting levels for sub-properties.

Returns:

maximum nesting depth

getIgnorePackageNamesStartingWith

public List<String> getIgnorePackageNamesStartingWith()

Returns a list of package name prefixes to ignore.

Returns:

list of strings that

getDefaultFilter

public static PropertyFilterDefinition getDefaultFilter()

Get the default nested property filtering conditions.

Returns:

default property filter