Improve doc

Author: AB-xdev

vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/AddFilterComponentsButtons.java

@@ -46,11 +46,10 @@ public void update(
 		filterComponentSuppliers.stream()
 			.filter(s -> nestedDepth < maxNestedDepth || !s.canCreateNested())
 			.map(s -> {
-				final Button btn =
-					new Button(
-						localizationConfig.getTranslation(s.displayKey(), this),
-						VaadinIcon.PLUS.create(),
-						ev -> onAddButtonClicked.accept(s));
+				final Button btn = new Button(
+					localizationConfig.getTranslation(s.displayKey(), this),
+					VaadinIcon.PLUS.create(),
+					ev -> onAddButtonClicked.accept(s));
 				btn.addThemeVariants(ButtonVariant.LUMO_SMALL);
 				btn.addClassNames(GridFilterStyles.ADD_FILTER_COMPONENTS_BUTTONS_BUTTON);
 				return btn;

vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/Operation.java

@@ -18,10 +18,25 @@
 import software.xdev.vaadin.gridfilter.business.value.ValueContainer;
 
 
+/**
+ * Defines a filter operation that can be applied on a value.
+ * <p>
+ * Examples include {@code =}, {@code <}, {@code >}, is empty, ...
+ * </p>
+ */
 public interface Operation<V extends ValueContainer>
 {
+	/**
+	 * Class of the {@link ValueContainer}
+	 */
 	Class<?> valueContainerClass();
 
+	/**
+	 * Checks if the value-class is supported.
+	 * <p>
+	 * inputs can be String.class, Double.class and so on
+	 * </p>
+	 */
 	boolean canHandle(Class<?> clazz);
 
 	String identifier();

vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/typevaluecomp/TypeValueComponentProvider.java

@@ -20,6 +20,9 @@
 import software.xdev.vaadin.gridfilter.business.value.ValueContainer;
 
 
+/**
+ * Provides components for a {@link ValueContainer} depending on type/class.
+ */
 public interface TypeValueComponentProvider<V extends ValueContainer>
 {
 	Class<?> valueContainerClass();
@@ -45,6 +48,9 @@ default TypeValueComponentData<V> getNewComponentDataWithDefaults(final Class<?>
 		return componentData;
 	}
 
+	/**
+	 * "Serializes" the current state for query parameters
+	 */
 	String serialize(TypeValueComponentData<V> typeValueComponentData);
 
 	@SuppressWarnings("unchecked")
@@ -53,6 +59,9 @@ default String serializeUnchecked(final TypeValueComponentData<?> typeValueCompo
 		return this.serialize((TypeValueComponentData<V>)typeValueComponentData);
 	}
 
+	/**
+	 * Restores the current state from query parameter based input
+	 */
 	void deserializeAndApply(String input, TypeValueComponentData<V> typeValueComponentData);
 
 	@SuppressWarnings("unchecked")

vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/value/ValueContainer.java

@@ -15,6 +15,9 @@
  */
 package software.xdev.vaadin.gridfilter.business.value;
 
+/**
+ * A value container which can be used for filtering.
+ */
 public interface ValueContainer
 {
 	boolean isValid();

vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/value/reuse/ValueReUseAdapter.java

@@ -18,6 +18,9 @@
 import software.xdev.vaadin.gridfilter.business.value.ValueContainer;
 
 
+/**
+ * Tries to reuse an existing value when changing between operations
+ */
 public interface ValueReUseAdapter<N extends ValueContainer>
 {
 	Class<N> newValueClass();

vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/queryparameter/GridFilterQueryParameterAdapter.java

@@ -29,6 +29,9 @@
 import software.xdev.vaadin.gridfilter.GridFilter;
 
 
+/**
+ * Synchronizes the current filters with query parameters
+ */
 public class GridFilterQueryParameterAdapter
 {
 	protected final GridFilter<?> gridFilter;