Package com.vaadin.flow.data.provider

Class DataCommunicator.Filter<F>

java.lang.Object
com.vaadin.flow.data.provider.DataCommunicator.Filter<F>
Type Parameters:
F - filter's type
All Implemented Interfaces:
Serializable
Enclosing class:
DataCommunicator<T>
public static final class DataCommunicator.Filter<F> extends Object implements Serializable
Wraps the component's filter object with the meta information whether this filter changing should trigger the item count change event.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Filter(F filterObject)
    Creates the filter object and sets it notify item count change listeners by default.
    Filter(F filterObject, boolean notifyOnChange)
    Creates the filter object and sets its lifespan.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    F
    getFilterObject()
    Returns a filter object for this component.
    int
    hashCode()
     
    boolean
    isNotifyOnChange()
    Returns whether to fire the item change event or not upon filter changing.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Filter

      public Filter(F filterObject)
      Creates the filter object and sets it notify item count change listeners by default.
      Parameters:
      filterObject - filter object of a component

    • Filter

      public Filter(F filterObject, boolean notifyOnChange)
      Creates the filter object and sets its lifespan.
      Parameters:
      filterObject - filter object of a component
      notifyOnChange - if true, then the data communicator will fire the item count change event as soon as filter change modifies the item count. If false, the item count change event won't be fired, even if the item count will be changed as a result of filtering.

  • Method Details

    • getFilterObject

      public F getFilterObject()
      Returns a filter object for this component.
      Returns:
      filter object

    • isNotifyOnChange

      public boolean isNotifyOnChange()
      Returns whether to fire the item change event or not upon filter changing.
      Returns:
      true, then the data communicator will fire the item count change event as soon as filter change modifies the item count. Returns false, the item count change event won't be fired, even if the item count will be changed as a result of filtering.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object