From 414d5b034080b35b94bb20fc66000390818ebc24 Mon Sep 17 00:00:00 2001 From: Henri Sara Date: Tue, 21 Mar 2017 14:50:24 +0200 Subject: [PATCH] Add missing since tags for 8.1.0.alpha1 (#8888) * Add missing since tags for 8.1.0.alpha1 * Update @since for DataCommunicatorClientRpc * Update @since for DataCommunicator --- .../HierarchicalDataCommunicatorConnector.java | 4 ++-- .../vaadin/data/provider/DataCommunicator.java | 15 +++++++++++++-- .../provider/HierarchicalDataCommunicator.java | 5 ++--- .../vaadin/data/provider/HierarchicalQuery.java | 6 +++--- server/src/main/java/com/vaadin/ui/Grid.java | 2 ++ .../shared/data/DataCommunicatorClientRpc.java | 2 ++ .../HierarchicalDataCommunicatorState.java | 2 +- 7 files changed, 25 insertions(+), 11 deletions(-) diff --git a/client/src/main/java/com/vaadin/client/connectors/data/HierarchicalDataCommunicatorConnector.java b/client/src/main/java/com/vaadin/client/connectors/data/HierarchicalDataCommunicatorConnector.java index f80a849fc9..c4a6e75a88 100644 --- a/client/src/main/java/com/vaadin/client/connectors/data/HierarchicalDataCommunicatorConnector.java +++ b/client/src/main/java/com/vaadin/client/connectors/data/HierarchicalDataCommunicatorConnector.java @@ -23,9 +23,9 @@ import elemental.json.JsonObject; /** * A connector for HierarchicalDataCommunicator class. - * + * * @author Vaadin Ltd - * @since + * @since 8.1 */ @Connect(HierarchicalDataCommunicator.class) public class HierarchicalDataCommunicatorConnector diff --git a/server/src/main/java/com/vaadin/data/provider/DataCommunicator.java b/server/src/main/java/com/vaadin/data/provider/DataCommunicator.java index ffa461e19f..b762e3db15 100644 --- a/server/src/main/java/com/vaadin/data/provider/DataCommunicator.java +++ b/server/src/main/java/com/vaadin/data/provider/DataCommunicator.java @@ -225,6 +225,7 @@ public class DataCommunicator extends AbstractExtension { * Set the range of rows to push for next response. * * @param pushRows + * @since 8.1 */ protected void setPushRows(Range pushRows) { this.pushRows = pushRows; @@ -234,6 +235,7 @@ public class DataCommunicator extends AbstractExtension { * Get the current range of rows to push in the next response. * * @return the range of rows to push + * @since 8.1 */ protected Range getPushRows() { return pushRows; @@ -241,8 +243,9 @@ public class DataCommunicator extends AbstractExtension { /** * Get the object used for filtering in this data communicator. - * + * * @return the filter object of this data communicator + * @since 8.1 */ protected Object getFilter() { return filter; @@ -250,8 +253,9 @@ public class DataCommunicator extends AbstractExtension { /** * Get the client rpc interface for this data communicator. - * + * * @return the client rpc interface for this data communicator + * @since 8.1 */ protected DataCommunicatorClientRpc getClientRpc() { return rpc; @@ -268,6 +272,7 @@ public class DataCommunicator extends AbstractExtension { * the index of the first cached row * @param cacheSize * the number of cached rows + * @since 8.1 */ protected void onRequestRows(int firstRowIndex, int numberOfRows, int firstCachedRowIndex, int cacheSize) { @@ -280,6 +285,7 @@ public class DataCommunicator extends AbstractExtension { * * @param keys * the keys of the rows that have been dropped + * @since 8.1 */ protected void onDropRows(JsonArray keys) { for (int i = 0; i < keys.length(); ++i) { @@ -303,6 +309,7 @@ public class DataCommunicator extends AbstractExtension { * * @param initial * {@code true} if initial data load, {@code false} if not + * @since 8.1 */ protected void sendDataToClient(boolean initial) { if (getDataProvider() == null) { @@ -421,6 +428,7 @@ public class DataCommunicator extends AbstractExtension { * Returns the active data handler. * * @return the active data handler + * @since 8.1 */ protected ActiveDataHandler getActiveDataHandler() { return handler; @@ -488,6 +496,7 @@ public class DataCommunicator extends AbstractExtension { * Returns the currently set updated data. * * @return the set of data that should be updated on the next response + * @since 8.1 */ protected Set getUpdatedData() { return updatedData; @@ -508,6 +517,7 @@ public class DataCommunicator extends AbstractExtension { * Returns the {@link Comparator} to use with in-memory sorting. * * @return comparator used to sort data + * @since 8.1 */ public Comparator getInMemorySorting() { return inMemorySorting; @@ -529,6 +539,7 @@ public class DataCommunicator extends AbstractExtension { * Returns the {@link QuerySortOrder} to use with backend sorting. * * @return list of sort order information to pass to a query + * @since 8.1 */ public List getBackEndSorting() { return backEndSorting; diff --git a/server/src/main/java/com/vaadin/data/provider/HierarchicalDataCommunicator.java b/server/src/main/java/com/vaadin/data/provider/HierarchicalDataCommunicator.java index 75e131df57..159dfbe1d4 100644 --- a/server/src/main/java/com/vaadin/data/provider/HierarchicalDataCommunicator.java +++ b/server/src/main/java/com/vaadin/data/provider/HierarchicalDataCommunicator.java @@ -43,7 +43,7 @@ import elemental.json.JsonObject; * @param * the bean type * @author Vaadin Ltd - * @since + * @since 8.1 */ public class HierarchicalDataCommunicator extends DataCommunicator { @@ -344,8 +344,7 @@ public class HierarchicalDataCommunicator extends DataCommunicator { int collapsedSubTreeSize = mapper.collapse(collapsedRowKey, collapsedRowIndex); - getClientRpc().removeRows(collapsedRowIndex + 1, - collapsedSubTreeSize); + getClientRpc().removeRows(collapsedRowIndex + 1, collapsedSubTreeSize); // FIXME seems like a slight overkill to do this just for refreshing // expanded status refresh(collapsedItem); diff --git a/server/src/main/java/com/vaadin/data/provider/HierarchicalQuery.java b/server/src/main/java/com/vaadin/data/provider/HierarchicalQuery.java index 6671464b31..92cf15ade9 100644 --- a/server/src/main/java/com/vaadin/data/provider/HierarchicalQuery.java +++ b/server/src/main/java/com/vaadin/data/provider/HierarchicalQuery.java @@ -28,7 +28,7 @@ import java.util.Optional; * @param * filter type * - * @since 8.0 + * @since 8.1 */ public class HierarchicalQuery extends Query { @@ -74,7 +74,7 @@ public class HierarchicalQuery extends Query { /** * Get the hierarchical parent object, can be null. - * + * * @return the hierarchical parent object, can be null */ public T getParent() { @@ -83,7 +83,7 @@ public class HierarchicalQuery extends Query { /** * Get an Optional of the hierarchical parent object. - * + * * @see #getParent() * @return the result of {@link #getParent()} wrapped by an Optional */ diff --git a/server/src/main/java/com/vaadin/ui/Grid.java b/server/src/main/java/com/vaadin/ui/Grid.java index 4604814879..733d6b8fcc 100644 --- a/server/src/main/java/com/vaadin/ui/Grid.java +++ b/server/src/main/java/com/vaadin/ui/Grid.java @@ -2115,6 +2115,7 @@ public class Grid extends AbstractListing implements HasComponents, * the custom data communicator to set * @see #Grid() * @see #Grid(PropertySet, DataCommunicator) + * @since 8.1 */ protected Grid(DataCommunicator dataCommunicator) { this(new PropertySet() { @@ -2162,6 +2163,7 @@ public class Grid extends AbstractListing implements HasComponents, * the property set implementation to use, not null. * @param dataCommunicator * the data communicator to use, notnull + * @since 8.1 */ protected Grid(PropertySet propertySet, DataCommunicator dataCommunicator) { diff --git a/shared/src/main/java/com/vaadin/shared/data/DataCommunicatorClientRpc.java b/shared/src/main/java/com/vaadin/shared/data/DataCommunicatorClientRpc.java index d268c887c4..e717434b96 100644 --- a/shared/src/main/java/com/vaadin/shared/data/DataCommunicatorClientRpc.java +++ b/shared/src/main/java/com/vaadin/shared/data/DataCommunicatorClientRpc.java @@ -63,6 +63,7 @@ public interface DataCommunicatorClientRpc extends ClientRpc { * the destination index of the new row data * @param count * the number of rows inserted + * @since 8.1 */ void insertRows(int firstRowIndex, int count); @@ -74,6 +75,7 @@ public interface DataCommunicatorClientRpc extends ClientRpc { * @param count * the number of removed rows, starting from * firstRowIndex + * @since 8.1 */ void removeRows(int firstRowIndex, int count); } diff --git a/shared/src/main/java/com/vaadin/shared/extension/datacommunicator/HierarchicalDataCommunicatorState.java b/shared/src/main/java/com/vaadin/shared/extension/datacommunicator/HierarchicalDataCommunicatorState.java index e56dbfe8a2..9d2e92d653 100644 --- a/shared/src/main/java/com/vaadin/shared/extension/datacommunicator/HierarchicalDataCommunicatorState.java +++ b/shared/src/main/java/com/vaadin/shared/extension/datacommunicator/HierarchicalDataCommunicatorState.java @@ -18,7 +18,7 @@ package com.vaadin.shared.extension.datacommunicator; /** * Shared state for HierarchicalDataCommunicator. * - * @since + * @since 8.1 */ public class HierarchicalDataCommunicatorState extends DataCommunicatorState { -- 2.39.5