From ed57efc07e97b14ba19a60ba523328dda16ada50 Mon Sep 17 00:00:00 2001 From: Teemu Suo-Anttila Date: Wed, 15 Nov 2017 16:09:39 +0200 Subject: [PATCH] Update since tags in JavaDoc (#10325) --- client/src/main/java/com/vaadin/client/UIDL.java | 2 +- .../src/main/java/com/vaadin/client/WidgetUtil.java | 2 +- .../com/vaadin/client/ui/VAbstractTextualDate.java | 4 ++-- .../main/java/com/vaadin/client/ui/VDateField.java | 8 ++++---- .../ui/datefield/AbstractDateFieldConnector.java | 2 +- .../java/com/vaadin/client/widgets/Escalator.java | 8 ++++---- .../main/java/com/vaadin/client/widgets/Grid.java | 4 ++-- .../main/java/com/vaadin/data/BeanPropertySet.java | 10 +++++----- server/src/main/java/com/vaadin/data/Binder.java | 2 +- .../src/main/java/com/vaadin/event/EventRouter.java | 2 +- .../main/java/com/vaadin/ui/AbstractDateField.java | 2 +- server/src/main/java/com/vaadin/ui/Grid.java | 4 ++-- .../ui/components/grid/DropIndexCalculator.java | 2 +- .../vaadin/ui/components/grid/GridDragSource.java | 2 +- .../com/vaadin/ui/components/grid/GridDragger.java | 2 +- .../vaadin/ui/components/grid/GridDropTarget.java | 6 +++--- .../components/grid/SourceDataProviderUpdater.java | 2 +- .../components/grid/TargetDataProviderUpdater.java | 2 +- .../src/main/java/com/vaadin/util/ReflectTools.java | 2 +- .../com/vaadin/shared/communication/SharedState.java | 2 +- .../ui/datefield/AbstractDateFieldServerRpc.java | 2 +- .../shared/ui/datefield/AbstractDateFieldState.java | 12 ++++++------ .../java/com/vaadin/shared/ui/grid/DropMode.java | 2 +- 23 files changed, 43 insertions(+), 43 deletions(-) diff --git a/client/src/main/java/com/vaadin/client/UIDL.java b/client/src/main/java/com/vaadin/client/UIDL.java index 70f49fd99a1..04541bb63cf 100644 --- a/client/src/main/java/com/vaadin/client/UIDL.java +++ b/client/src/main/java/com/vaadin/client/UIDL.java @@ -311,7 +311,7 @@ public Iterator getChildIterator() { *

* * @return an iterator for iterating over UIDL children - * @since + * @since 8.2 */ @Override public Iterator iterator() { diff --git a/client/src/main/java/com/vaadin/client/WidgetUtil.java b/client/src/main/java/com/vaadin/client/WidgetUtil.java index 09ef5a3c6a5..cf4addc37ed 100644 --- a/client/src/main/java/com/vaadin/client/WidgetUtil.java +++ b/client/src/main/java/com/vaadin/client/WidgetUtil.java @@ -1859,7 +1859,7 @@ public static int getRelativeY(Element element, NativeEvent event) { * @param obj * the object of which the type is examined * @return {@code true} if the object is a string; {@code false} if not - * @since + * @since 8.2 */ public static native boolean isString(Object obj) /*-{ diff --git a/client/src/main/java/com/vaadin/client/ui/VAbstractTextualDate.java b/client/src/main/java/com/vaadin/client/ui/VAbstractTextualDate.java index 340e4faf6a3..66ddf1d829e 100644 --- a/client/src/main/java/com/vaadin/client/ui/VAbstractTextualDate.java +++ b/client/src/main/java/com/vaadin/client/ui/VAbstractTextualDate.java @@ -263,7 +263,7 @@ public void onChange(ChangeEvent event) { * Updates the {@link VDateField#bufferedResolutions bufferedResolutions}, * then {@link #sendBufferedValues() sends} the values to the server. * - * @since + * @since 8.2 */ protected final void updateAndSendBufferedValues() { updateBufferedResolutions(); @@ -282,7 +282,7 @@ protected final void updateAndSendBufferedValues() { * Note that this method should not send the buffered values, but use * {@link #updateAndSendBufferedValues()} instead * - * @since + * @since 8.2 */ protected void updateBufferedResolutions() { Date currentDate = getDate(); diff --git a/client/src/main/java/com/vaadin/client/ui/VDateField.java b/client/src/main/java/com/vaadin/client/ui/VDateField.java index 3bfa8e9649c..39aeda26c41 100644 --- a/client/src/main/java/com/vaadin/client/ui/VDateField.java +++ b/client/src/main/java/com/vaadin/client/ui/VDateField.java @@ -60,7 +60,7 @@ public abstract class VDateField> extends FlowPanel /** * The RPC send calls to the server. * - * @since + * @since 8.2 */ public AbstractDateFieldServerRpc rpc; @@ -72,7 +72,7 @@ public abstract class VDateField> extends FlowPanel * * The value can be {@code null}. * - * @since + * @since 8.2 */ protected Map bufferedResolutions = new HashMap<>(); @@ -80,7 +80,7 @@ public abstract class VDateField> extends FlowPanel * A temporary holder of the date string, which would be sent to the server * through {@link #sendBufferedValues()}. * - * @since + * @since 8.2 */ protected String bufferedDateString; @@ -266,7 +266,7 @@ public String getResolutionVariable(R resolution) { * Sends the {@link #bufferedDateString} and {@link #bufferedResolutions} to * the server, and clears their values. * - * @since + * @since 8.2 */ public void sendBufferedValues() { rpc.update(bufferedDateString, diff --git a/client/src/main/java/com/vaadin/client/ui/datefield/AbstractDateFieldConnector.java b/client/src/main/java/com/vaadin/client/ui/datefield/AbstractDateFieldConnector.java index b31447fcacc..4b52ee50f66 100644 --- a/client/src/main/java/com/vaadin/client/ui/datefield/AbstractDateFieldConnector.java +++ b/client/src/main/java/com/vaadin/client/ui/datefield/AbstractDateFieldConnector.java @@ -65,7 +65,7 @@ private Map getTimeValues() { * from Resolution to the corresponding value. * * @return default date component map - * @since + * @since 8.2 */ protected Map getDefaultValues() { VDateField widget = getWidget(); diff --git a/client/src/main/java/com/vaadin/client/widgets/Escalator.java b/client/src/main/java/com/vaadin/client/widgets/Escalator.java index f54cecad6d4..b3008d28dc1 100644 --- a/client/src/main/java/com/vaadin/client/widgets/Escalator.java +++ b/client/src/main/java/com/vaadin/client/widgets/Escalator.java @@ -1197,7 +1197,7 @@ public void updateAriaRowCount() { * @param element element that should get the role attribute * @param role role to be added * - * @since + * @since 8.2 */ public void updateRole(final Element element, AriaGridRole role) { element.setAttribute("role", role.getName()); @@ -1207,7 +1207,7 @@ public void updateRole(final Element element, AriaGridRole role) { /** * Holds the currently used aria roles within the grid for rows and cells. * - * @since + * @since 8.2 */ public enum AriaGridRole { @@ -1290,7 +1290,7 @@ public TableSectionElement getElement() { * * @return the role attribute for the element to represent cells * - * @since + * @since 8.2 */ protected AriaGridRole getCellElementRole() { return AriaGridRole.GRIDCELL; @@ -1304,7 +1304,7 @@ protected AriaGridRole getCellElementRole() { * * @return the role attribute for the element to represent rows * - * @since + * @since 8.2 */ protected AriaGridRole getRowElementRole() { return AriaGridRole.ROW; diff --git a/client/src/main/java/com/vaadin/client/widgets/Grid.java b/client/src/main/java/com/vaadin/client/widgets/Grid.java index 3dee1c0ebaa..266bffd3f6d 100755 --- a/client/src/main/java/com/vaadin/client/widgets/Grid.java +++ b/client/src/main/java/com/vaadin/client/widgets/Grid.java @@ -4840,7 +4840,7 @@ public String getHeaderCaption() { * The header aria-label for this column * @return the column itself * - * @since + * @since 8.2 */ public Column setAssistiveCaption(String caption) { if (!Objects.equals(this.assistiveCaption, caption)) { @@ -4857,7 +4857,7 @@ public Column setAssistiveCaption(String caption) { * * @return the header aria-label string * - * @since + * @since 8.2 */ public String getAssistiveCaption() { return assistiveCaption; diff --git a/server/src/main/java/com/vaadin/data/BeanPropertySet.java b/server/src/main/java/com/vaadin/data/BeanPropertySet.java index 1371f769d6e..fbd60c85639 100644 --- a/server/src/main/java/com/vaadin/data/BeanPropertySet.java +++ b/server/src/main/java/com/vaadin/data/BeanPropertySet.java @@ -219,14 +219,14 @@ public static class NestedBeanPropertyDefinition /** * Default maximum depth for scanning nested properties. * - * @since + * @since 8.2 */ protected static final int MAX_PROPERTY_NESTING_DEPTH = 10; /** * Class containing the constraints for filtering nested properties. * - * @since + * @since 8.2 * */ protected static class PropertyFilterDefinition @@ -304,7 +304,7 @@ public NestedBeanPropertyDefinition(BeanPropertySet propertySet, * use format grandparent.parent.property for name if * {@code true}, needed when creating nested definitions * recursively like in findNestedDefinitions - * @since + * @since 8.2 */ public NestedBeanPropertyDefinition(BeanPropertySet propertySet, PropertyDefinition parent, PropertyDescriptor descriptor, @@ -373,7 +373,7 @@ public String getName() { /** * Key for identifying cached BeanPropertySet instances. * - * @since + * @since 8.2 */ private static class InstanceKey implements Serializable { private Class type; @@ -549,7 +549,7 @@ public static PropertySet get(Class beanType) { * @param filterDefinition * filtering conditions for nested properties * @return the bean property set, not null - * @since + * @since 8.2 */ @SuppressWarnings("unchecked") public static PropertySet get(Class beanType, diff --git a/server/src/main/java/com/vaadin/data/Binder.java b/server/src/main/java/com/vaadin/data/Binder.java index c7cce9cb95e..96739f175d1 100644 --- a/server/src/main/java/com/vaadin/data/Binder.java +++ b/server/src/main/java/com/vaadin/data/Binder.java @@ -1277,7 +1277,7 @@ public Binder(Class beanType) { * the bean type to use, not {@code null} * @param scanNestedDefinitions * if {@code true}, scan for nested property definitions as well - * @since + * @since 8.2 */ public Binder(Class beanType, boolean scanNestedDefinitions) { this(BeanPropertySet.get(beanType, scanNestedDefinitions, diff --git a/server/src/main/java/com/vaadin/event/EventRouter.java b/server/src/main/java/com/vaadin/event/EventRouter.java index 61beae76314..b4dd43d9f44 100644 --- a/server/src/main/java/com/vaadin/event/EventRouter.java +++ b/server/src/main/java/com/vaadin/event/EventRouter.java @@ -104,7 +104,7 @@ public Registration addListener(Class eventType, Object object, * unless {@code method} has exactly one match in {@code target} * @throws NullPointerException * if {@code target} is {@code null} - * @since + * @since 8.2 */ public Registration addListener(Class eventType, Object target, Method method, String eventIdentifier, SharedState state) { diff --git a/server/src/main/java/com/vaadin/ui/AbstractDateField.java b/server/src/main/java/com/vaadin/ui/AbstractDateField.java index 3247bbf1e6f..5c176f3a554 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractDateField.java +++ b/server/src/main/java/com/vaadin/ui/AbstractDateField.java @@ -236,7 +236,7 @@ public void beforeClientResponse(boolean initial) { * defined in the specified {@code resolutions} * * @return the date object built from the specified resolutions - * @since + * @since 8.2 */ protected T reconstructDateFromFields(Map resolutions, T oldDate) { diff --git a/server/src/main/java/com/vaadin/ui/Grid.java b/server/src/main/java/com/vaadin/ui/Grid.java index e6cc4d44543..4b5ab2a84b8 100644 --- a/server/src/main/java/com/vaadin/ui/Grid.java +++ b/server/src/main/java/com/vaadin/ui/Grid.java @@ -1212,7 +1212,7 @@ public boolean isSortable() { * * @return this column * - * @since + * @since 8.2 */ public Column setAssistiveCaption(String caption) { if (Objects.equals(caption, getAssistiveCaption())) { @@ -1227,7 +1227,7 @@ public Column setAssistiveCaption(String caption) { * * @return header caption * - * @since + * @since 8.2 */ public String getAssistiveCaption() { return getState(false).assistiveCaption; diff --git a/server/src/main/java/com/vaadin/ui/components/grid/DropIndexCalculator.java b/server/src/main/java/com/vaadin/ui/components/grid/DropIndexCalculator.java index 1598937e623..e61b2df8e6c 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/DropIndexCalculator.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/DropIndexCalculator.java @@ -22,7 +22,7 @@ * grid. * * @author Vaadin Ltd - * @since + * @since 8.2 * @see GridDragger * @param * the bean type diff --git a/server/src/main/java/com/vaadin/ui/components/grid/GridDragSource.java b/server/src/main/java/com/vaadin/ui/components/grid/GridDragSource.java index 150df40aecf..c5a3b0dd941 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/GridDragSource.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/GridDragSource.java @@ -100,7 +100,7 @@ public GridDragSource(Grid target) { * Gets the grid this extension has been attached to. * * @return the grid for this extension - * @since + * @since 8.2 */ public Grid getGrid() { return getParent(); diff --git a/server/src/main/java/com/vaadin/ui/components/grid/GridDragger.java b/server/src/main/java/com/vaadin/ui/components/grid/GridDragger.java index 5258000c462..a7186a08016 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/GridDragger.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/GridDragger.java @@ -47,7 +47,7 @@ * @param * The Grid bean type. * @author Vaadin Ltd - * @since + * @since 8.2 */ public class GridDragger implements Serializable { diff --git a/server/src/main/java/com/vaadin/ui/components/grid/GridDropTarget.java b/server/src/main/java/com/vaadin/ui/components/grid/GridDropTarget.java index a9e9a02264b..e4b175fe811 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/GridDropTarget.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/GridDropTarget.java @@ -62,7 +62,7 @@ public GridDropTarget(Grid target, DropMode dropMode) { * Gets the grid this extension has been attached to. * * @return the grid for this extension - * @since + * @since 8.2 */ public Grid getGrid() { return getParent(); @@ -144,7 +144,7 @@ public DropMode getDropMode() { * @param dropAllowedOnSortedGridRows * {@code true} for allowing, {@code false} for not allowing * drops on sorted grid rows - * @since + * @since 8.2 */ public void setDropAllowedOnSortedGridRows( boolean dropAllowedOnSortedGridRows) { @@ -191,7 +191,7 @@ private void updateDropModeForSortedGrid(boolean sorted) { * * @return whether drop are allowed for the grid's rows when user has sorted * the grid - * @since + * @since 8.2 */ public boolean isDropAllowedOnSortedGridRows() { return dropAllowedOnSortedGridRows; diff --git a/server/src/main/java/com/vaadin/ui/components/grid/SourceDataProviderUpdater.java b/server/src/main/java/com/vaadin/ui/components/grid/SourceDataProviderUpdater.java index 2a56776077d..f84c2bd5db4 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/SourceDataProviderUpdater.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/SourceDataProviderUpdater.java @@ -28,7 +28,7 @@ * drop. * * @author Vaadin Ltd - * @since + * @since 8.2 * * @param * the bean type diff --git a/server/src/main/java/com/vaadin/ui/components/grid/TargetDataProviderUpdater.java b/server/src/main/java/com/vaadin/ui/components/grid/TargetDataProviderUpdater.java index 17e7848d589..9596eb7a039 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/TargetDataProviderUpdater.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/TargetDataProviderUpdater.java @@ -28,7 +28,7 @@ * drop. * * @author Vaadin Ltd - * @since + * @since 8.2 * * @param * the bean type diff --git a/server/src/main/java/com/vaadin/util/ReflectTools.java b/server/src/main/java/com/vaadin/util/ReflectTools.java index 561281b5b71..84aab29fbd2 100644 --- a/server/src/main/java/com/vaadin/util/ReflectTools.java +++ b/server/src/main/java/com/vaadin/util/ReflectTools.java @@ -333,7 +333,7 @@ private static void checkClassAccessibility(Class cls) { * @return the first non-synthetic method * @throws IllegalStateException * if the specified class does not have found method - * @since + * @since 8.2 */ public static Method getMethod(Class listenerClass) { for (Method m : listenerClass.getDeclaredMethods()) { diff --git a/shared/src/main/java/com/vaadin/shared/communication/SharedState.java b/shared/src/main/java/com/vaadin/shared/communication/SharedState.java index a17ddf59141..872327e8fd6 100644 --- a/shared/src/main/java/com/vaadin/shared/communication/SharedState.java +++ b/shared/src/main/java/com/vaadin/shared/communication/SharedState.java @@ -66,7 +66,7 @@ public class SharedState implements Serializable { * A Map of event identifiers with registered listeners, {@code key} is * event identifier, {@code value} is the listeners count. * - * @since + * @since 8.2 */ @NoLayout public Map registeredEventListeners; diff --git a/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldServerRpc.java b/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldServerRpc.java index 3e6edd7df37..eb34e7ff162 100644 --- a/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldServerRpc.java +++ b/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldServerRpc.java @@ -22,7 +22,7 @@ /** * RPC interface for calls from client to server. * - * @since + * @since 8.2 */ public interface AbstractDateFieldServerRpc extends ServerRpc { diff --git a/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java b/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java index 11f0c13fd1e..83544ec6bb0 100644 --- a/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java +++ b/shared/src/main/java/com/vaadin/shared/ui/datefield/AbstractDateFieldState.java @@ -60,7 +60,7 @@ public class AbstractDateFieldState extends AbstractFieldState { /** * The used Locale, can be {@code null}. * - * @since + * @since 8.2 */ public String locale; @@ -68,14 +68,14 @@ public class AbstractDateFieldState extends AbstractFieldState { * Overridden date format string, can be {@code null} if default formatting * of the components locale is used. * - * @since + * @since 8.2 */ public String format; /** * Whether the date/time interpretation is lenient. * - * @since + * @since 8.2 */ public boolean lenient; @@ -87,14 +87,14 @@ public class AbstractDateFieldState extends AbstractFieldState { * * The value can be {@code null} * - * @since + * @since 8.2 */ public Map resolutions = new HashMap<>(); /** * Determines if week numbers are shown in the date selector. * - * @since + * @since 8.2 */ public boolean showISOWeekNumbers; @@ -102,7 +102,7 @@ public class AbstractDateFieldState extends AbstractFieldState { * Was the last entered string parsable? If this flag is false, datefields * internal validator does not pass. * - * @since + * @since 8.2 */ public boolean parsable = true; diff --git a/shared/src/main/java/com/vaadin/shared/ui/grid/DropMode.java b/shared/src/main/java/com/vaadin/shared/ui/grid/DropMode.java index 4294a4fa1af..1dbafbcbc09 100644 --- a/shared/src/main/java/com/vaadin/shared/ui/grid/DropMode.java +++ b/shared/src/main/java/com/vaadin/shared/ui/grid/DropMode.java @@ -56,7 +56,7 @@ public enum DropMode { * target used when the grid is completely empty. It can also be configured * to be used automatically when the user has sorted the grid. * - * @since + * @since 8.2 */ ON_GRID; }