diff options
| author | Henri Sara <henri.sara@gmail.com> | 2017-02-16 11:38:39 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-02-16 11:38:39 +0200 |
| commit | 4f047f06fad8882ac81e6770d6ebf022a8331196 (patch) | |
| tree | b8733b706db2c3c3e528309264d452c8bc3c575a /server/src/main/java/com/vaadin | |
| parent | 3841ea1f7309b068a0407031a6e745a3a0736aca (diff) | |
| download | vaadin-framework-4f047f06fad8882ac81e6770d6ebf022a8331196.tar.gz vaadin-framework-4f047f06fad8882ac81e6770d6ebf022a8331196.zip | |
Fix since tags for 8.0 (#8575)
Fix since tags for the server and shared modules and new types in client.
Diffstat (limited to 'server/src/main/java/com/vaadin')
79 files changed, 198 insertions, 39 deletions
diff --git a/server/src/main/java/com/vaadin/annotations/HtmlImport.java b/server/src/main/java/com/vaadin/annotations/HtmlImport.java index f815134dbb..81b4db87ca 100644 --- a/server/src/main/java/com/vaadin/annotations/HtmlImport.java +++ b/server/src/main/java/com/vaadin/annotations/HtmlImport.java @@ -56,7 +56,7 @@ import com.vaadin.server.ClientConnector; * the {@code init()} method of the client side connector is invoked. * * @author Vaadin Ltd - * @since 8.0.0 + * @since 8.0 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) diff --git a/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForHtml.java b/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForHtml.java index be009bc4ce..42d71c59e5 100644 --- a/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForHtml.java +++ b/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForHtml.java @@ -29,6 +29,7 @@ import java.lang.annotation.Target; * {@link HtmlImport @HtmlImport} should be used instead. * * @author Vaadin Ltd + * @since 8.0 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) diff --git a/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForJS.java b/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForJS.java index 6b4152dfa0..969362dd24 100644 --- a/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForJS.java +++ b/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForJS.java @@ -29,6 +29,7 @@ import java.lang.annotation.Target; * {@link JavaScript @JavaScript} should be used instead. * * @author Vaadin Ltd + * @since 8.0 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) diff --git a/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForSS.java b/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForSS.java index 2c3d8b19c0..e7039f60b6 100644 --- a/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForSS.java +++ b/server/src/main/java/com/vaadin/annotations/InternalContainerAnnotationForSS.java @@ -29,6 +29,7 @@ import java.lang.annotation.Target; * {@link StyleSheet @StyleSheet} should be used instead. * * @author Vaadin Ltd + * @since 8.0 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) diff --git a/server/src/main/java/com/vaadin/annotations/PropertyId.java b/server/src/main/java/com/vaadin/annotations/PropertyId.java index 62ac330c17..ecfceda706 100644 --- a/server/src/main/java/com/vaadin/annotations/PropertyId.java +++ b/server/src/main/java/com/vaadin/annotations/PropertyId.java @@ -53,7 +53,7 @@ import com.vaadin.data.HasValue; </pre> * </code> * - * @since 7.0 + * @since 8.0 * @author Vaadin Ltd */ @Target({ ElementType.FIELD }) diff --git a/server/src/main/java/com/vaadin/data/BeanPropertySet.java b/server/src/main/java/com/vaadin/data/BeanPropertySet.java index d6ab364aff..073e9ce62f 100644 --- a/server/src/main/java/com/vaadin/data/BeanPropertySet.java +++ b/server/src/main/java/com/vaadin/data/BeanPropertySet.java @@ -40,7 +40,7 @@ import com.vaadin.util.ReflectTools; * * @author Vaadin Ltd * - * @since + * @since 8.0 * * @param <T> * the type of the bean diff --git a/server/src/main/java/com/vaadin/data/HasItems.java b/server/src/main/java/com/vaadin/data/HasItems.java index 03e85be6fd..18dd9fc99d 100644 --- a/server/src/main/java/com/vaadin/data/HasItems.java +++ b/server/src/main/java/com/vaadin/data/HasItems.java @@ -31,6 +31,8 @@ import com.vaadin.ui.Component; * * @author Vaadin Ltd * + * @since 8.0 + * * @param <T> * the type of the displayed item */ @@ -51,13 +53,13 @@ public interface HasItems<T> extends Component, Serializable { * {@link #setDataProvider(DataProvider)} method. It means that the items * collection can be accessed later on via * {@link ListDataProvider#getItems()}: - * + * * <pre> * <code> * HasDataProvider<String> listing = new CheckBoxGroup<>(); * listing.setItems(Arrays.asList("a","b")); * ... - * + * * Collection<String> collection = ((ListDataProvider<String>)listing.getDataProvider()).getItems(); * </code> * </pre> @@ -81,20 +83,20 @@ public interface HasItems<T> extends Component, Serializable { * {@link #setDataProvider(DataProvider)} method. It means that the items * collection can be accessed later on via * {@link ListDataProvider#getItems()}: - * + * * <pre> * <code> * HasDataProvider<String> listing = new CheckBoxGroup<>(); * listing.setItems(Arrays.asList("a","b")); * ... - * + * * Collection<String> collection = ((ListDataProvider<String>)listing.getDataProvider()).getItems(); * </code> * </pre> * <p> - * + * * @see #setItems(Collection) - * + * * @param items * the data items to display */ @@ -116,13 +118,13 @@ public interface HasItems<T> extends Component, Serializable { * {@link #setDataProvider(DataProvider)} method. It means that the items * collection can be accessed later on via * {@link ListDataProvider#getItems()}: - * + * * <pre> * <code> * HasDataProvider<String> listing = new CheckBoxGroup<>(); * listing.setItems(Arrays.asList("a","b")); * ... - * + * * Collection<String> collection = ((ListDataProvider<String>)listing.getDataProvider()).getItems(); * </code> * </pre> diff --git a/server/src/main/java/com/vaadin/data/PropertyDefinition.java b/server/src/main/java/com/vaadin/data/PropertyDefinition.java index 79bb2159b4..4d11e678a5 100644 --- a/server/src/main/java/com/vaadin/data/PropertyDefinition.java +++ b/server/src/main/java/com/vaadin/data/PropertyDefinition.java @@ -24,7 +24,7 @@ import com.vaadin.server.Setter; * A property from a {@link PropertySet}. * * @author Vaadin Ltd - * @since + * @since 8.0 * * @param <T> * the type of the property set diff --git a/server/src/main/java/com/vaadin/data/PropertySet.java b/server/src/main/java/com/vaadin/data/PropertySet.java index 7b557dc293..5ffae4f384 100644 --- a/server/src/main/java/com/vaadin/data/PropertySet.java +++ b/server/src/main/java/com/vaadin/data/PropertySet.java @@ -25,7 +25,7 @@ import java.util.stream.Stream; * * @author Vaadin Ltd * - * @since + * @since 8.0 * * @param <T> * the type for which the properties are defined diff --git a/server/src/main/java/com/vaadin/data/Result.java b/server/src/main/java/com/vaadin/data/Result.java index cf4b88adf0..4d340a2e88 100644 --- a/server/src/main/java/com/vaadin/data/Result.java +++ b/server/src/main/java/com/vaadin/data/Result.java @@ -36,6 +36,8 @@ import com.vaadin.server.SerializableSupplier; * * @param <R> * the result value type + * + * @since 8.0 */ public interface Result<R> extends Serializable { diff --git a/server/src/main/java/com/vaadin/data/SimpleResult.java b/server/src/main/java/com/vaadin/data/SimpleResult.java index 85dee60c8f..85d8c8ed4e 100644 --- a/server/src/main/java/com/vaadin/data/SimpleResult.java +++ b/server/src/main/java/com/vaadin/data/SimpleResult.java @@ -26,6 +26,8 @@ import com.vaadin.server.SerializableFunction; * * @param <R> * the result value type + * + * @since 8.0 */ class SimpleResult<R> implements Result<R> { diff --git a/server/src/main/java/com/vaadin/data/StatusChangeEvent.java b/server/src/main/java/com/vaadin/data/StatusChangeEvent.java index acef1bac75..07b195330a 100644 --- a/server/src/main/java/com/vaadin/data/StatusChangeEvent.java +++ b/server/src/main/java/com/vaadin/data/StatusChangeEvent.java @@ -41,6 +41,7 @@ import com.vaadin.server.Setter; * * @author Vaadin Ltd * + * @since 8.0 */ public class StatusChangeEvent extends EventObject { diff --git a/server/src/main/java/com/vaadin/data/Validator.java b/server/src/main/java/com/vaadin/data/Validator.java index 8fc5b0785e..6dca15a8ed 100644 --- a/server/src/main/java/com/vaadin/data/Validator.java +++ b/server/src/main/java/com/vaadin/data/Validator.java @@ -41,6 +41,8 @@ import com.vaadin.server.SerializablePredicate; * * @author Vaadin Ltd. * + * @since 8.0 + * * @param <T> * the type of the value to validate * diff --git a/server/src/main/java/com/vaadin/data/converter/LocalDateTimeToDateConverter.java b/server/src/main/java/com/vaadin/data/converter/LocalDateTimeToDateConverter.java index e427d956e3..e5fa45a3fb 100644 --- a/server/src/main/java/com/vaadin/data/converter/LocalDateTimeToDateConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/LocalDateTimeToDateConverter.java @@ -33,6 +33,7 @@ import com.vaadin.ui.InlineDateTimeField; * {@link InlineDateTimeField} is bound to a {@link Date} property. * * @author Vaadin Ltd + * @since 8.0 */ public class LocalDateTimeToDateConverter implements Converter<LocalDateTime, Date> { diff --git a/server/src/main/java/com/vaadin/data/converter/LocalDateToDateConverter.java b/server/src/main/java/com/vaadin/data/converter/LocalDateToDateConverter.java index f649091039..999295d6aa 100644 --- a/server/src/main/java/com/vaadin/data/converter/LocalDateToDateConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/LocalDateToDateConverter.java @@ -33,6 +33,7 @@ import com.vaadin.ui.InlineDateField; * {@link InlineDateField} is bound to a {@link Date} property. * * @author Vaadin Ltd + * @since 8.0 */ public class LocalDateToDateConverter implements Converter<LocalDate, Date> { diff --git a/server/src/main/java/com/vaadin/data/provider/AbstractBackEndDataProvider.java b/server/src/main/java/com/vaadin/data/provider/AbstractBackEndDataProvider.java index 9b08bb8c1d..b829934340 100644 --- a/server/src/main/java/com/vaadin/data/provider/AbstractBackEndDataProvider.java +++ b/server/src/main/java/com/vaadin/data/provider/AbstractBackEndDataProvider.java @@ -29,6 +29,7 @@ import java.util.stream.Stream; * data provider data type * @param <F> * data provider filter type + * @since 8.0 */ public abstract class AbstractBackEndDataProvider<T, F> extends AbstractDataProvider<T, F> implements BackEndDataProvider<T, F> { diff --git a/server/src/main/java/com/vaadin/data/provider/BackEndDataProvider.java b/server/src/main/java/com/vaadin/data/provider/BackEndDataProvider.java index 13694010c7..d2cb5c8c44 100644 --- a/server/src/main/java/com/vaadin/data/provider/BackEndDataProvider.java +++ b/server/src/main/java/com/vaadin/data/provider/BackEndDataProvider.java @@ -26,6 +26,7 @@ import java.util.Objects; * data provider data type * @param <F> * data provider filter type + * @since 8.0 */ public interface BackEndDataProvider<T, F> extends DataProvider<T, F> { @@ -48,9 +49,9 @@ public interface BackEndDataProvider<T, F> extends DataProvider<T, F> { /** * Sets the sort order to use, given a {@link QuerySortOrderBuilder}. * Shorthand for {@code setSortOrders(builder.build())}. - * + * * @see QuerySortOrderBuilder - * + * * @param builder * the sort builder to retrieve the sort order from * @throws NullPointerException diff --git a/server/src/main/java/com/vaadin/data/provider/CallbackDataProvider.java b/server/src/main/java/com/vaadin/data/provider/CallbackDataProvider.java index bd34cc939f..c1705cfe30 100644 --- a/server/src/main/java/com/vaadin/data/provider/CallbackDataProvider.java +++ b/server/src/main/java/com/vaadin/data/provider/CallbackDataProvider.java @@ -26,6 +26,7 @@ import com.vaadin.data.ValueProvider; * another callback for counting the number of available items. * * @author Vaadin Ltd + * @since 8.0 * * @param <T> * data provider data type diff --git a/server/src/main/java/com/vaadin/data/provider/ConfigurableFilterDataProvider.java b/server/src/main/java/com/vaadin/data/provider/ConfigurableFilterDataProvider.java index 8521e5498a..bc9bf805f9 100644 --- a/server/src/main/java/com/vaadin/data/provider/ConfigurableFilterDataProvider.java +++ b/server/src/main/java/com/vaadin/data/provider/ConfigurableFilterDataProvider.java @@ -20,6 +20,7 @@ package com.vaadin.data.provider; * applied to all queries. * * @author Vaadin Ltd + * @since 8.0 * * @param <T> * the data provider item type diff --git a/server/src/main/java/com/vaadin/data/provider/ConfigurableFilterDataProviderWrapper.java b/server/src/main/java/com/vaadin/data/provider/ConfigurableFilterDataProviderWrapper.java index b83fc98013..a711f8e0d4 100644 --- a/server/src/main/java/com/vaadin/data/provider/ConfigurableFilterDataProviderWrapper.java +++ b/server/src/main/java/com/vaadin/data/provider/ConfigurableFilterDataProviderWrapper.java @@ -21,6 +21,7 @@ package com.vaadin.data.provider; * the wrapped provider through the query. * * @author Vaadin Ltd + * @since 8.0 * * @param <T> * the data provider item type @@ -63,7 +64,7 @@ public abstract class ConfigurableFilterDataProviderWrapper<T, Q, C, F> * filter instance that can be passed to the wrapped data provider. Will not * be called if the configured filter is <code>null</code> and the query has * no filter. - * + * * @param queryFilter * the filter received through the query, or <code>null</code> if * no filter was provided in the query diff --git a/server/src/main/java/com/vaadin/data/provider/GridSortOrder.java b/server/src/main/java/com/vaadin/data/provider/GridSortOrder.java index ffb17d301d..cf53718caf 100644 --- a/server/src/main/java/com/vaadin/data/provider/GridSortOrder.java +++ b/server/src/main/java/com/vaadin/data/provider/GridSortOrder.java @@ -23,12 +23,13 @@ import com.vaadin.ui.Grid.Column; * * @param <T> * the grid type + * @since 8.0 */ public class GridSortOrder<T> extends SortOrder<Column<T, ?>> { /** * Construct sorting information for usage in a {@link Grid}. - * + * * @param column * the column to be sorted * @param direction diff --git a/server/src/main/java/com/vaadin/data/provider/GridSortOrderBuilder.java b/server/src/main/java/com/vaadin/data/provider/GridSortOrderBuilder.java index 3aba2eba6b..43509dd318 100644 --- a/server/src/main/java/com/vaadin/data/provider/GridSortOrderBuilder.java +++ b/server/src/main/java/com/vaadin/data/provider/GridSortOrderBuilder.java @@ -22,14 +22,15 @@ import com.vaadin.ui.Grid.Column; * Helper classes with fluent API for constructing {@link GridSortOrder} lists. * When the sort order is ready to be passed on, calling {@link #build()} will * create the list of sort orders. - * + * * @see GridSortOrder * @see #thenAsc(Column) * @see #thenDesc(Column) * @see #build() - * + * * @param <T> * the type of the grid + * @since 8.0 */ public class GridSortOrderBuilder<T> extends SortOrderBuilder<GridSortOrder<T>, Column<T, ?>> { diff --git a/server/src/main/java/com/vaadin/data/provider/ListDataProvider.java b/server/src/main/java/com/vaadin/data/provider/ListDataProvider.java index 2f1e17d673..8fc6d4a364 100644 --- a/server/src/main/java/com/vaadin/data/provider/ListDataProvider.java +++ b/server/src/main/java/com/vaadin/data/provider/ListDataProvider.java @@ -36,6 +36,7 @@ import com.vaadin.ui.UI; * * @param <T> * data type + * @since 8.0 */ public class ListDataProvider<T> extends AbstractDataProvider<T, SerializablePredicate<T>> implements diff --git a/server/src/main/java/com/vaadin/data/provider/QuerySortOrder.java b/server/src/main/java/com/vaadin/data/provider/QuerySortOrder.java index 7f0a76bf91..8e93359432 100644 --- a/server/src/main/java/com/vaadin/data/provider/QuerySortOrder.java +++ b/server/src/main/java/com/vaadin/data/provider/QuerySortOrder.java @@ -21,6 +21,7 @@ import com.vaadin.shared.data.sort.SortDirection; * Sorting information for {@link Query}. * * @see Query + * @since 8.0 */ public class QuerySortOrder extends SortOrder<String> { diff --git a/server/src/main/java/com/vaadin/data/provider/QuerySortOrderBuilder.java b/server/src/main/java/com/vaadin/data/provider/QuerySortOrderBuilder.java index eebe257973..dacda0d669 100644 --- a/server/src/main/java/com/vaadin/data/provider/QuerySortOrderBuilder.java +++ b/server/src/main/java/com/vaadin/data/provider/QuerySortOrderBuilder.java @@ -26,6 +26,7 @@ import com.vaadin.shared.data.sort.SortDirection; * @see #thenDesc(String) * @see #thenDesc(String) * @see #build() + * @since 8.0 */ public class QuerySortOrderBuilder extends SortOrderBuilder<QuerySortOrder, String> { diff --git a/server/src/main/java/com/vaadin/data/provider/SortOrder.java b/server/src/main/java/com/vaadin/data/provider/SortOrder.java index cb6a62668a..f806def6d1 100644 --- a/server/src/main/java/com/vaadin/data/provider/SortOrder.java +++ b/server/src/main/java/com/vaadin/data/provider/SortOrder.java @@ -25,6 +25,7 @@ import com.vaadin.shared.data.sort.SortDirection; * @param <T> * the type of the sorting information, usually a String (field id) * or a {@link java.util.Comparator}. + * @since 8.0 */ public class SortOrder<T> implements Serializable { diff --git a/server/src/main/java/com/vaadin/data/provider/SortOrderBuilder.java b/server/src/main/java/com/vaadin/data/provider/SortOrderBuilder.java index 29488b4415..433fbfafd4 100644 --- a/server/src/main/java/com/vaadin/data/provider/SortOrderBuilder.java +++ b/server/src/main/java/com/vaadin/data/provider/SortOrderBuilder.java @@ -35,6 +35,7 @@ import com.vaadin.shared.data.sort.SortDirection; * @see SortOrderBuilder#thenAsc(Object) * @see SortOrderBuilder#thenDesc(Object) * @see #build() + * @since 8.0 */ public abstract class SortOrderBuilder<T extends SortOrder<V>, V> implements Serializable { diff --git a/server/src/main/java/com/vaadin/event/Action.java b/server/src/main/java/com/vaadin/event/Action.java index b26dac14c9..fceea66a5b 100644 --- a/server/src/main/java/com/vaadin/event/Action.java +++ b/server/src/main/java/com/vaadin/event/Action.java @@ -108,6 +108,15 @@ public class Action implements Serializable { } public interface ShortcutNotifier extends Serializable { + /** + * Add a shortcut listener and return a registration object for + * unregistering it. + * + * @param shortcut + * listener to add + * @return registration for unregistering the listener + * @since 8.0 + */ public Registration addShortcutListener(ShortcutListener shortcut); /** diff --git a/server/src/main/java/com/vaadin/event/ContextClickEvent.java b/server/src/main/java/com/vaadin/event/ContextClickEvent.java index ba62a2ec14..2d6ebfefe9 100644 --- a/server/src/main/java/com/vaadin/event/ContextClickEvent.java +++ b/server/src/main/java/com/vaadin/event/ContextClickEvent.java @@ -71,6 +71,7 @@ public class ContextClickEvent extends ClickEvent { * @param listener * the context click listener to add, not null * @return a registration object for removing the listener + * @since 8.0 */ public Registration addContextClickListener( ContextClickListener listener); diff --git a/server/src/main/java/com/vaadin/event/FieldEvents.java b/server/src/main/java/com/vaadin/event/FieldEvents.java index 75f8b38ff9..2b0a0f6286 100644 --- a/server/src/main/java/com/vaadin/event/FieldEvents.java +++ b/server/src/main/java/com/vaadin/event/FieldEvents.java @@ -192,7 +192,7 @@ public interface FieldEvents { * using a provided event handler. * * @author Vaadin Ltd - * + * @since 8.0 */ public static class FocusAndBlurServerRpcDecorator extends FocusAndBlurServerRpcImpl { diff --git a/server/src/main/java/com/vaadin/event/LayoutEvents.java b/server/src/main/java/com/vaadin/event/LayoutEvents.java index bc30981e51..6e70687598 100644 --- a/server/src/main/java/com/vaadin/event/LayoutEvents.java +++ b/server/src/main/java/com/vaadin/event/LayoutEvents.java @@ -79,6 +79,7 @@ public interface LayoutEvents { * @param listener * The listener to add * @return a registration object for removing the listener + * @since 8.0 */ public Registration addLayoutClickListener( LayoutClickListener listener); diff --git a/server/src/main/java/com/vaadin/event/MethodEventSource.java b/server/src/main/java/com/vaadin/event/MethodEventSource.java index e59ccfd4d4..7e55a5acd1 100644 --- a/server/src/main/java/com/vaadin/event/MethodEventSource.java +++ b/server/src/main/java/com/vaadin/event/MethodEventSource.java @@ -62,6 +62,7 @@ public interface MethodEventSource extends Serializable { * <code>object</code> * @throws NullPointerException * if {@code object} is {@code null} + * @since 8.0 */ public Registration addListener(Class<?> eventType, Object object, Method method); @@ -99,6 +100,7 @@ public interface MethodEventSource extends Serializable { * <code>object</code> * @throws NullPointerException * if {@code object} is {@code null} + * @since 8.0 */ public Registration addListener(Class<?> eventType, Object object, String methodName); diff --git a/server/src/main/java/com/vaadin/event/UIEvents.java b/server/src/main/java/com/vaadin/event/UIEvents.java index 5c91fe78a9..90773b8938 100644 --- a/server/src/main/java/com/vaadin/event/UIEvents.java +++ b/server/src/main/java/com/vaadin/event/UIEvents.java @@ -104,6 +104,7 @@ public interface UIEvents { * @param listener * the {@link PollListener} to add, not null * @return a registration object for removing the listener + * @since 8.0 */ public Registration addPollListener(PollListener listener); diff --git a/server/src/main/java/com/vaadin/navigator/Navigator.java b/server/src/main/java/com/vaadin/navigator/Navigator.java index 6a55b36ab8..f6029e7d07 100644 --- a/server/src/main/java/com/vaadin/navigator/Navigator.java +++ b/server/src/main/java/com/vaadin/navigator/Navigator.java @@ -969,6 +969,7 @@ public class Navigator implements Serializable { * * @param listener * Listener to invoke during a view change. + * @since 8.0 */ public Registration addViewChangeListener(ViewChangeListener listener) { listeners.add(listener); diff --git a/server/src/main/java/com/vaadin/server/AbstractClientConnector.java b/server/src/main/java/com/vaadin/server/AbstractClientConnector.java index baab7a04da..3bce462522 100644 --- a/server/src/main/java/com/vaadin/server/AbstractClientConnector.java +++ b/server/src/main/java/com/vaadin/server/AbstractClientConnector.java @@ -751,7 +751,7 @@ public abstract class AbstractClientConnector * @param method * the activation method. * @return a registration object for removing the listener - * @since 6.2 + * @since 8.0 */ protected Registration addListener(String eventIdentifier, Class<?> eventType, Object target, Method method) { @@ -891,6 +891,7 @@ public abstract class AbstractClientConnector * @deprecated As of 7.0. This method should be avoided. Use * {@link #addListener(Class, Object, Method)} or * {@link #addListener(String, Class, Object, Method)} instead. + * @since 8.0 */ @Override @Deprecated diff --git a/server/src/main/java/com/vaadin/server/ClientConnector.java b/server/src/main/java/com/vaadin/server/ClientConnector.java index 97a14bc5c8..9b2df069ba 100644 --- a/server/src/main/java/com/vaadin/server/ClientConnector.java +++ b/server/src/main/java/com/vaadin/server/ClientConnector.java @@ -98,11 +98,27 @@ public interface ClientConnector extends Connector { public void detach(DetachEvent event); } + /** + * Add a listener for connector attach events. + * + * @since 8.0 + * + * @param listener + * @return Registration for unregistering the listener + */ public Registration addAttachListener(AttachListener listener); @Deprecated public void removeAttachListener(AttachListener listener); + /** + * Add a listener for connector detach events. + * + * @since 8.0 + * + * @param listener + * @return Registration for unregistering the listener + */ public Registration addDetachListener(DetachListener listener); @Deprecated diff --git a/server/src/main/java/com/vaadin/server/ErrorMessageProducer.java b/server/src/main/java/com/vaadin/server/ErrorMessageProducer.java index 22cd4a87f4..b6a34ef8de 100644 --- a/server/src/main/java/com/vaadin/server/ErrorMessageProducer.java +++ b/server/src/main/java/com/vaadin/server/ErrorMessageProducer.java @@ -20,6 +20,8 @@ import java.io.Serializable; /** * Interface implemented by old Vaadin 7 exception types to produce the error * message to show in a component. + * + * @since 8.0 */ @Deprecated public interface ErrorMessageProducer extends Serializable { diff --git a/server/src/main/java/com/vaadin/server/Page.java b/server/src/main/java/com/vaadin/server/Page.java index bf55e7ce9f..1cebe42802 100644 --- a/server/src/main/java/com/vaadin/server/Page.java +++ b/server/src/main/java/com/vaadin/server/Page.java @@ -26,7 +26,6 @@ import java.util.LinkedList; import java.util.List; import com.vaadin.event.EventRouter; -import com.vaadin.event.FieldEvents.FocusListener; import com.vaadin.shared.Registration; import com.vaadin.shared.ui.BorderStyle; import com.vaadin.shared.ui.ui.PageClientRpc; @@ -596,6 +595,7 @@ public class Page implements Serializable { * @return a registration object for removing the listener * @deprecated Use {@link Page#addPopStateListener(PopStateListener)} * instead + * @since 8.0 */ @Deprecated public Registration addUriFragmentChangedListener( @@ -845,6 +845,7 @@ public class Page implements Serializable { * @see BrowserWindowResizeListener#browserWindowResized(BrowserWindowResizeEvent) * @see UI#setResizeLazy(boolean) * @see Registration + * @since 8.0 */ public Registration addBrowserWindowResizeListener( BrowserWindowResizeListener resizeListener) { @@ -1135,7 +1136,7 @@ public class Page implements Serializable { * For internal use only. Used to update the server-side location when the * client-side location changes. * - * @since 7.2 + * @since 8.0 * * @param location * the new location URI diff --git a/server/src/main/java/com/vaadin/server/VaadinPortletSession.java b/server/src/main/java/com/vaadin/server/VaadinPortletSession.java index 68a1470e05..18e3fee80e 100644 --- a/server/src/main/java/com/vaadin/server/VaadinPortletSession.java +++ b/server/src/main/java/com/vaadin/server/VaadinPortletSession.java @@ -123,6 +123,7 @@ public class VaadinPortletSession extends VaadinSession { * * @param listener * to add + * @since 8.0 */ public Registration addPortletListener(PortletListener listener) { portletListeners.add(listener); diff --git a/server/src/main/java/com/vaadin/server/VaadinService.java b/server/src/main/java/com/vaadin/server/VaadinService.java index 6d0c442785..80ae39cb35 100644 --- a/server/src/main/java/com/vaadin/server/VaadinService.java +++ b/server/src/main/java/com/vaadin/server/VaadinService.java @@ -442,6 +442,7 @@ public abstract class VaadinService implements Serializable { * @param listener * the Vaadin service session initialization listener * @return a registration object for removing the listener + * @since 8.0 */ public Registration addSessionInitListener(SessionInitListener listener) { sessionInitListeners.add(listener); @@ -477,6 +478,7 @@ public abstract class VaadinService implements Serializable { * @param listener * the vaadin service session destroy listener * @return a registration object for removing the listener + * @since 8.0 */ public Registration addSessionDestroyListener( SessionDestroyListener listener) { @@ -1905,7 +1907,7 @@ public abstract class VaadinService implements Serializable { * it is not guaranteed that listeners will be invoked in the order they * were added. * - * @since 7.2 + * @since 8.0 * @param listener * the service destroy listener to add * diff --git a/server/src/main/java/com/vaadin/server/VaadinServlet.java b/server/src/main/java/com/vaadin/server/VaadinServlet.java index a03979216b..e9c302f7a4 100644 --- a/server/src/main/java/com/vaadin/server/VaadinServlet.java +++ b/server/src/main/java/com/vaadin/server/VaadinServlet.java @@ -1268,6 +1268,16 @@ public class VaadinServlet extends HttpServlet implements Constants { return getStaticFilePath(request) != null; } + /** + * Returns the relative path at which static files are served for a request + * (if any). + * + * @param request + * HTTP request + * @return relative servlet path or null if the request path does not + * contain "/VAADIN/" or the request has no path info + * @since 8.0 + */ protected String getStaticFilePath(HttpServletRequest request) { String pathInfo = request.getPathInfo(); if (pathInfo == null) { diff --git a/server/src/main/java/com/vaadin/server/VaadinSession.java b/server/src/main/java/com/vaadin/server/VaadinSession.java index 5979933285..36692c00c2 100644 --- a/server/src/main/java/com/vaadin/server/VaadinSession.java +++ b/server/src/main/java/com/vaadin/server/VaadinSession.java @@ -615,6 +615,7 @@ public class VaadinSession implements HttpSessionBindingListener, Serializable { * * @param converterFactory * The converter factory used in the session + * @since 8.0 */ @Deprecated public void setConverterFactory(Object converterFactory) { @@ -811,6 +812,7 @@ public class VaadinSession implements HttpSessionBindingListener, Serializable { * @param listener * the bootstrap listener to add * @return a registration object for removing the listener + * @since 8.0 */ public Registration addBootstrapListener(BootstrapListener listener) { assert hasLock(); diff --git a/server/src/main/java/com/vaadin/ui/AbstractComponent.java b/server/src/main/java/com/vaadin/ui/AbstractComponent.java index e2e51a2eca..c95c6cef15 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractComponent.java +++ b/server/src/main/java/com/vaadin/ui/AbstractComponent.java @@ -513,6 +513,7 @@ public abstract class AbstractComponent extends AbstractClientConnector * the new description string for the component. * @param mode * the content mode for the description + * @since 8.0 */ public void setDescription(String description, ContentMode mode) { getState().description = description; @@ -1420,6 +1421,7 @@ public abstract class AbstractComponent extends AbstractClientConnector * @param visible * <code>true</code> to make the required indicator visible, * <code>false</code> if not + * @since 8.0 */ protected void setRequiredIndicatorVisible(boolean visible) { if (getState(false) instanceof AbstractFieldState) { @@ -1443,6 +1445,7 @@ public abstract class AbstractComponent extends AbstractClientConnector * * @return <code>true</code> if visible, <code>false</code> if not * @see #setRequiredIndicatorVisible(boolean) + * @since 8.0 */ protected boolean isRequiredIndicatorVisible() { if (getState(false) instanceof AbstractFieldState) { diff --git a/server/src/main/java/com/vaadin/ui/AbstractSplitPanel.java b/server/src/main/java/com/vaadin/ui/AbstractSplitPanel.java index 593f350af5..f518b2ba5c 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractSplitPanel.java +++ b/server/src/main/java/com/vaadin/ui/AbstractSplitPanel.java @@ -594,7 +594,7 @@ public abstract class AbstractSplitPanel extends AbstractComponentContainer { /** * Register a listener to handle {@link SplitPositionChangeEvent}s. * - * @since 7.5.0 + * @since 8.0 * @param listener * {@link SplitPositionChangeListener} to be registered. */ diff --git a/server/src/main/java/com/vaadin/ui/AbstractTextField.java b/server/src/main/java/com/vaadin/ui/AbstractTextField.java index c716c66978..9da5e9eedc 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractTextField.java +++ b/server/src/main/java/com/vaadin/ui/AbstractTextField.java @@ -134,6 +134,7 @@ public abstract class AbstractTextField extends AbstractField<String> * * @param placeholder * the placeholder text to set + * @since 8.0 */ public void setPlaceholder(String placeholder) { getState().placeholder = placeholder; diff --git a/server/src/main/java/com/vaadin/ui/Button.java b/server/src/main/java/com/vaadin/ui/Button.java index e57f8244ed..d0194924c4 100644 --- a/server/src/main/java/com/vaadin/ui/Button.java +++ b/server/src/main/java/com/vaadin/ui/Button.java @@ -313,6 +313,7 @@ public class Button extends AbstractFocusable * @param listener * the Listener to be added. * @return a registration object for removing the listener + * @since 8.0 */ public Registration addClickListener(ClickListener listener) { return addListener(ClickEvent.class, listener, diff --git a/server/src/main/java/com/vaadin/ui/ComboBox.java b/server/src/main/java/com/vaadin/ui/ComboBox.java index ed1e9d8beb..54a3eea430 100644 --- a/server/src/main/java/com/vaadin/ui/ComboBox.java +++ b/server/src/main/java/com/vaadin/ui/ComboBox.java @@ -78,6 +78,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * * @param <T> * item (bean) type in ComboBox + * @since 8.0 */ @FunctionalInterface public interface FetchItemsCallback<T> extends Serializable { @@ -104,6 +105,8 @@ public class ComboBox<T> extends AbstractSingleSelect<T> /** * Handler that adds a new item based on user input when the new items * allowed mode is active. + * + * @since 8.0 */ @FunctionalInterface public interface NewItemHandler extends SerializableConsumer<String> { @@ -116,6 +119,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * * @param <T> * item type + * @since 8.0 */ protected static class DeclarativeStyleGenerator<T> implements StyleGenerator<T> { @@ -300,6 +304,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * * @param listDataProvider * the list data provider to use, not <code>null</code> + * @since 8.0 */ public void setDataProvider(ListDataProvider<T> listDataProvider) { // Cannot use the case insensitive contains shorthand from @@ -323,6 +328,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * into the ComboBox * @param items * the data items to display + * @since 8.0 */ public void setItems(CaptionFilter captionFilter, Collection<T> items) { ListDataProvider<T> listDataProvider = DataProvider.ofCollection(items); @@ -340,6 +346,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * into the ComboBox * @param listDataProvider * the list data provider to use, not <code>null</code> + * @since 8.0 */ public void setDataProvider(CaptionFilter captionFilter, ListDataProvider<T> listDataProvider) { @@ -364,6 +371,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * into the ComboBox * @param items * the data items to display + * @since 8.0 */ public void setItems(CaptionFilter captionFilter, @SuppressWarnings("unchecked") T... items) { @@ -376,6 +384,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * * @see #setPlaceholder(String) * @return the current placeholder string, or null if not enabled + * @since 8.0 */ public String getPlaceholder() { return getState(false).placeholder; @@ -387,6 +396,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * * @param placeholder * the desired placeholder, or null to disable + * @since 8.0 */ public void setPlaceholder(String placeholder) { getState().placeholder = placeholder; @@ -468,6 +478,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * Returns whether the user is allowed to select nothing in the combo box. * * @return true if empty selection is allowed, false otherwise + * @since 8.0 */ public boolean isEmptySelectionAllowed() { return getState(false).emptySelectionAllowed; @@ -480,6 +491,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * @param emptySelectionAllowed * true to allow not selecting anything, false to require * selection + * @since 8.0 */ public void setEmptySelectionAllowed(boolean emptySelectionAllowed) { getState().emptySelectionAllowed = emptySelectionAllowed; @@ -496,6 +508,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * @see #isSelected(Object) * * @return the empty selection caption, not {@code null} + * @since 8.0 */ public String getEmptySelectionCaption() { return getState(false).emptySelectionCaption; @@ -513,6 +526,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * @param caption * the caption to set, not {@code null} * @see #isSelected(Object) + * @since 8.0 */ public void setEmptySelectionCaption(String caption) { Objects.nonNull(caption); @@ -592,6 +606,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * the item style generator to set, not null * @throws NullPointerException * if {@code itemStyleGenerator} is {@code null} + * @since 8.0 */ public void setStyleGenerator(StyleGenerator<T> itemStyleGenerator) { Objects.requireNonNull(itemStyleGenerator, @@ -609,6 +624,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * @see #setStyleGenerator(StyleGenerator) * * @return the currently used item style generator, not null + * @since 8.0 */ public StyleGenerator<T> getStyleGenerator() { return itemStyleGenerator; @@ -635,6 +651,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * @param newItemHandler * handler called for new items, null to only permit the * selection of existing items + * @since 8.0 */ public void setNewItemHandler(NewItemHandler newItemHandler) { this.newItemHandler = newItemHandler; @@ -833,6 +850,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * * @see #setItems(CaptionFilter, Collection) * @see #setItems(CaptionFilter, Object[]) + * @since 8.0 */ @FunctionalInterface public interface CaptionFilter diff --git a/server/src/main/java/com/vaadin/ui/Component.java b/server/src/main/java/com/vaadin/ui/Component.java index 1215d848aa..c690e945cb 100644 --- a/server/src/main/java/com/vaadin/ui/Component.java +++ b/server/src/main/java/com/vaadin/ui/Component.java @@ -47,8 +47,8 @@ import com.vaadin.ui.declarative.DesignContext; * * <p> * The {@link #getParent()} method allows retrieving the parent component of a - * component. While there is a {@link #setParent(HasComponents)}, you - * rarely need it as you normally add components with the + * component. While there is a {@link #setParent(HasComponents)}, you rarely + * need it as you normally add components with the * {@link ComponentContainer#addComponent(Component) addComponent()} method of * the layout or other {@code ComponentContainer}, which automatically sets the * parent. @@ -900,6 +900,7 @@ public interface Component extends ClientConnector, Sizeable, Serializable { * @return a registration object for removing this listener * @see Component.Event * @see Registration + * @since 8.0 */ public Registration addListener(Component.Listener listener); diff --git a/server/src/main/java/com/vaadin/ui/Dependency.java b/server/src/main/java/com/vaadin/ui/Dependency.java index 8c82dc0275..509b9d3039 100644 --- a/server/src/main/java/com/vaadin/ui/Dependency.java +++ b/server/src/main/java/com/vaadin/ui/Dependency.java @@ -30,6 +30,7 @@ import com.vaadin.server.LegacyCommunicationManager; * Represents a stylesheet or JavaScript to include on the page. * * @author Vaadin Ltd + * @since 8.0 */ public class Dependency implements Serializable { /** diff --git a/server/src/main/java/com/vaadin/ui/Embedded.java b/server/src/main/java/com/vaadin/ui/Embedded.java index 33f5459081..ef31790e8a 100644 --- a/server/src/main/java/com/vaadin/ui/Embedded.java +++ b/server/src/main/java/com/vaadin/ui/Embedded.java @@ -528,6 +528,7 @@ public class Embedded extends AbstractComponent implements LegacyComponent { * @param listener * The listener to add * @return a registration object for removing the listener + * @since 8.0 */ public Registration addClickListener(ClickListener listener) { return addListener(EventId.CLICK_EVENT_IDENTIFIER, ClickEvent.class, diff --git a/server/src/main/java/com/vaadin/ui/HasComponents.java b/server/src/main/java/com/vaadin/ui/HasComponents.java index bb10ca57f6..763f4b67cd 100644 --- a/server/src/main/java/com/vaadin/ui/HasComponents.java +++ b/server/src/main/java/com/vaadin/ui/HasComponents.java @@ -56,6 +56,7 @@ public interface HasComponents extends Component, Iterable<Component> { * @param listener * the listener to add, not null * @return a registration object for removing the listener + * @since 8.0 */ public Registration addComponentAttachListener( ComponentAttachListener listener); @@ -70,6 +71,7 @@ public interface HasComponents extends Component, Iterable<Component> { * the registration object returned from * {@link #addComponentAttachListener(ComponentAttachListener)} * . + * @since 8.0 */ @Deprecated public void removeComponentAttachListener( diff --git a/server/src/main/java/com/vaadin/ui/HasValueChangeMode.java b/server/src/main/java/com/vaadin/ui/HasValueChangeMode.java index a59be6d058..2bed6bc2e9 100644 --- a/server/src/main/java/com/vaadin/ui/HasValueChangeMode.java +++ b/server/src/main/java/com/vaadin/ui/HasValueChangeMode.java @@ -20,6 +20,8 @@ import com.vaadin.shared.ui.ValueChangeMode; /** * Implemented by components which support value change modes. + * + * @since 8.0 */ public interface HasValueChangeMode extends Component { /** diff --git a/server/src/main/java/com/vaadin/ui/HorizontalLayout.java b/server/src/main/java/com/vaadin/ui/HorizontalLayout.java index 95edc69e61..a6187e623b 100644 --- a/server/src/main/java/com/vaadin/ui/HorizontalLayout.java +++ b/server/src/main/java/com/vaadin/ui/HorizontalLayout.java @@ -72,6 +72,7 @@ public class HorizontalLayout extends AbstractOrderedLayout { * * @param components * the components to set, not <code>null</code> + * @since 8.0 */ public void addComponentsAndExpand(Component... components) { addComponents(components); diff --git a/server/src/main/java/com/vaadin/ui/IconGenerator.java b/server/src/main/java/com/vaadin/ui/IconGenerator.java index 50da1c5303..7ea1a9b38c 100644 --- a/server/src/main/java/com/vaadin/ui/IconGenerator.java +++ b/server/src/main/java/com/vaadin/ui/IconGenerator.java @@ -23,6 +23,7 @@ import com.vaadin.server.SerializableFunction; * * @param <T> * item type for which the icon is generated + * @since 8.0 */ @FunctionalInterface public interface IconGenerator<T> extends SerializableFunction<T, Resource> { diff --git a/server/src/main/java/com/vaadin/ui/Image.java b/server/src/main/java/com/vaadin/ui/Image.java index ce19f5c410..ce839961b8 100644 --- a/server/src/main/java/com/vaadin/ui/Image.java +++ b/server/src/main/java/com/vaadin/ui/Image.java @@ -88,6 +88,7 @@ public class Image extends AbstractEmbedded { * @param listener * The listener to add, not null * @return a registration object for removing the listener + * @since 8.0 */ public Registration addClickListener(ClickListener listener) { return addListener(EventId.CLICK_EVENT_IDENTIFIER, ClickEvent.class, diff --git a/server/src/main/java/com/vaadin/ui/Label.java b/server/src/main/java/com/vaadin/ui/Label.java index 22ed77703c..c2fd132060 100644 --- a/server/src/main/java/com/vaadin/ui/Label.java +++ b/server/src/main/java/com/vaadin/ui/Label.java @@ -61,6 +61,7 @@ public class Label extends AbstractComponent { * the text to set * @param contentMode * the content mode to use + * @since 8.0 */ public Label(String text, ContentMode contentMode) { setValue(text); @@ -83,6 +84,7 @@ public class Label extends AbstractComponent { * @return the content mode of the label * * @see ContentMode + * @since 8.0 */ public ContentMode getContentMode() { return getState(false).contentMode; @@ -95,6 +97,7 @@ public class Label extends AbstractComponent { * the content mode to set * * @see ContentMode + * @since 8.0 */ public void setContentMode(ContentMode contentMode) { if (contentMode == null) { diff --git a/server/src/main/java/com/vaadin/ui/ListSelect.java b/server/src/main/java/com/vaadin/ui/ListSelect.java index 515570cc38..60180d2971 100644 --- a/server/src/main/java/com/vaadin/ui/ListSelect.java +++ b/server/src/main/java/com/vaadin/ui/ListSelect.java @@ -62,6 +62,7 @@ public class ListSelect<T> extends AbstractMultiSelect<T> * the caption to set, can be {@code null} * @param dataProvider * the data provider, not {@code null} + * @since 8.0 */ public ListSelect(String caption, DataProvider<T, ?> dataProvider) { this(caption); diff --git a/server/src/main/java/com/vaadin/ui/LoginForm.java b/server/src/main/java/com/vaadin/ui/LoginForm.java index 2dfd1d0483..400a9826fa 100644 --- a/server/src/main/java/com/vaadin/ui/LoginForm.java +++ b/server/src/main/java/com/vaadin/ui/LoginForm.java @@ -271,9 +271,9 @@ public class LoginForm extends AbstractSingleComponentContainer { * implementations, override {@link #createUsernameField()}, * {@link #createPasswordField()} and {@link #createLoginButton()}. If you * only want to change the default captions, override - * {@link #getUsernameCaption()}, {@link #getPasswordCaption()} - * and {@link #getLoginButtonCaption()}. You do not have to use the login - * button in your layout. + * {@link #getUsernameCaption()}, {@link #getPasswordCaption()} and + * {@link #getLoginButtonCaption()}. You do not have to use the login button + * in your layout. * * @param userNameField * the user name text field @@ -359,6 +359,7 @@ public class LoginForm extends AbstractSingleComponentContainer { * @param listener * the listener to add * @return a registration object for removing the listener + * @since 8.0 */ public Registration addLoginListener(LoginListener listener) { return addListener(LoginEvent.class, listener, ON_LOGIN_METHOD); diff --git a/server/src/main/java/com/vaadin/ui/NativeSelect.java b/server/src/main/java/com/vaadin/ui/NativeSelect.java index f7427568ff..2c994b8384 100644 --- a/server/src/main/java/com/vaadin/ui/NativeSelect.java +++ b/server/src/main/java/com/vaadin/ui/NativeSelect.java @@ -145,6 +145,7 @@ public class NativeSelect<T> extends AbstractSingleSelect<T> * Returns whether the user is allowed to select nothing in the combo box. * * @return true if empty selection is allowed, false otherwise + * @since 8.0 */ public boolean isEmptySelectionAllowed() { return getState(false).emptySelectionAllowed; @@ -157,6 +158,7 @@ public class NativeSelect<T> extends AbstractSingleSelect<T> * @param emptySelectionAllowed * true to allow not selecting anything, false to require * selection + * @since 8.0 */ public void setEmptySelectionAllowed(boolean emptySelectionAllowed) { getState().emptySelectionAllowed = emptySelectionAllowed; @@ -173,6 +175,7 @@ public class NativeSelect<T> extends AbstractSingleSelect<T> * @see #isSelected(Object) * * @return the empty selection caption, not {@code null} + * @since 8.0 */ public String getEmptySelectionCaption() { return getState(false).emptySelectionCaption; @@ -190,6 +193,7 @@ public class NativeSelect<T> extends AbstractSingleSelect<T> * @param caption * the caption to set, not {@code null} * @see #isSelected(Object) + * @since 8.0 */ public void setEmptySelectionCaption(String caption) { Objects.nonNull(caption); diff --git a/server/src/main/java/com/vaadin/ui/Panel.java b/server/src/main/java/com/vaadin/ui/Panel.java index ceadf2567d..13d2b4027e 100644 --- a/server/src/main/java/com/vaadin/ui/Panel.java +++ b/server/src/main/java/com/vaadin/ui/Panel.java @@ -271,6 +271,7 @@ public class Panel extends AbstractSingleComponentContainer * @param listener * The listener to add, not null * @return a registration object for removing the listener + * @since 8.0 */ public Registration addClickListener(ClickListener listener) { return addListener(EventId.CLICK_EVENT_IDENTIFIER, ClickEvent.class, diff --git a/server/src/main/java/com/vaadin/ui/PasswordField.java b/server/src/main/java/com/vaadin/ui/PasswordField.java index f0e443434a..41a66f462d 100644 --- a/server/src/main/java/com/vaadin/ui/PasswordField.java +++ b/server/src/main/java/com/vaadin/ui/PasswordField.java @@ -68,6 +68,7 @@ public class PasswordField extends TextField { * * @param valueChangeListener * the value change listener, not {@code null} + * @since 8.0 */ public PasswordField(ValueChangeListener<String> valueChangeListener) { super(valueChangeListener); @@ -84,6 +85,7 @@ public class PasswordField extends TextField { * the caption for the field * @param valueChangeListener * the value change listener, not {@code null} + * @since 8.0 */ public PasswordField(String caption, ValueChangeListener<String> valueChangeListener) { @@ -96,13 +98,14 @@ public class PasswordField extends TextField { * <p> * The listener is called when the value of this {@code PasswordField} is * changed either by the user or programmatically. - * + * * @param caption * the caption for the field * @param value * the value for the field, not {@code null} * @param valueChangeListener * the value change listener, not {@code null} + * @since 8.0 */ public PasswordField(String caption, String value, ValueChangeListener<String> valueChangeListener) { diff --git a/server/src/main/java/com/vaadin/ui/PopupView.java b/server/src/main/java/com/vaadin/ui/PopupView.java index 632f176906..d6671be191 100644 --- a/server/src/main/java/com/vaadin/ui/PopupView.java +++ b/server/src/main/java/com/vaadin/ui/PopupView.java @@ -334,6 +334,7 @@ public class PopupView extends AbstractComponent implements HasComponents { * @param listener * the listener to add, not null * @return a registration object for removing the listener + * @since 8.0 */ public Registration addPopupVisibilityListener( PopupVisibilityListener listener) { diff --git a/server/src/main/java/com/vaadin/ui/ProgressBar.java b/server/src/main/java/com/vaadin/ui/ProgressBar.java index e5d82a62b0..ead781b141 100644 --- a/server/src/main/java/com/vaadin/ui/ProgressBar.java +++ b/server/src/main/java/com/vaadin/ui/ProgressBar.java @@ -71,6 +71,7 @@ public class ProgressBar extends AbstractComponent { * * @param newValue * the current progress value + * @since 8.0 */ public void setValue(float newValue) { getState().state = newValue; @@ -131,6 +132,8 @@ public class ProgressBar extends AbstractComponent { /** * Resets the value of this component, effectively displaying zero progress. + * + * @since 8.0 */ public void reset() { setValue(DEFAULT_VALUE); diff --git a/server/src/main/java/com/vaadin/ui/RichTextArea.java b/server/src/main/java/com/vaadin/ui/RichTextArea.java index b556a5281b..1497e78f77 100644 --- a/server/src/main/java/com/vaadin/ui/RichTextArea.java +++ b/server/src/main/java/com/vaadin/ui/RichTextArea.java @@ -18,7 +18,6 @@ package com.vaadin.ui; import java.util.Objects; -import elemental.json.Json; import org.jsoup.nodes.Element; import com.vaadin.shared.ui.ValueChangeMode; @@ -27,6 +26,8 @@ import com.vaadin.shared.ui.richtextarea.RichTextAreaServerRpc; import com.vaadin.shared.ui.richtextarea.RichTextAreaState; import com.vaadin.ui.declarative.DesignContext; +import elemental.json.Json; + /** * A simple RichTextArea to edit HTML format text. */ @@ -88,6 +89,7 @@ public class RichTextArea extends AbstractField<String> * * @param valueChangeListener * the value change listener, not {@code null} + * @since 8.0 */ public RichTextArea(ValueChangeListener<String> valueChangeListener) { addValueChangeListener(valueChangeListener); @@ -104,6 +106,7 @@ public class RichTextArea extends AbstractField<String> * the caption for the field * @param valueChangeListener * the value change listener, not {@code null} + * @since 8.0 */ public RichTextArea(String caption, ValueChangeListener<String> valueChangeListener) { @@ -124,6 +127,7 @@ public class RichTextArea extends AbstractField<String> * the value for the field, not {@code null} * @param valueChangeListener * the value change listener, not {@code null} + * @since 8.0 */ public RichTextArea(String caption, String value, ValueChangeListener<String> valueChangeListener) { diff --git a/server/src/main/java/com/vaadin/ui/SingleSelect.java b/server/src/main/java/com/vaadin/ui/SingleSelect.java index f2ae85e95e..1c0d5b53eb 100644 --- a/server/src/main/java/com/vaadin/ui/SingleSelect.java +++ b/server/src/main/java/com/vaadin/ui/SingleSelect.java @@ -21,6 +21,7 @@ import com.vaadin.data.HasValue; * Single selection component whose selection is treated as a value. * * @author Vaadin Ltd + * @since 8.0 * * @param <V> * the selection value type diff --git a/server/src/main/java/com/vaadin/ui/TabSheet.java b/server/src/main/java/com/vaadin/ui/TabSheet.java index a94925a263..b48d35592a 100644 --- a/server/src/main/java/com/vaadin/ui/TabSheet.java +++ b/server/src/main/java/com/vaadin/ui/TabSheet.java @@ -829,6 +829,7 @@ public class TabSheet extends AbstractComponentContainer * @param listener * the Listener to be added, not null * @return a registration object for removing the listener + * @since 8.0 */ public Registration addSelectedTabChangeListener( SelectedTabChangeListener listener) { diff --git a/server/src/main/java/com/vaadin/ui/TextArea.java b/server/src/main/java/com/vaadin/ui/TextArea.java index 06a52e30c9..614343500f 100644 --- a/server/src/main/java/com/vaadin/ui/TextArea.java +++ b/server/src/main/java/com/vaadin/ui/TextArea.java @@ -78,6 +78,7 @@ public class TextArea extends AbstractTextField { * * @param valueChangeListener * the value change listener, not {@code null} + * @since 8.0 */ public TextArea(ValueChangeListener<String> valueChangeListener) { addValueChangeListener(valueChangeListener); @@ -94,6 +95,7 @@ public class TextArea extends AbstractTextField { * the caption for the field * @param valueChangeListener * the value change listener, not {@code null} + * @since 8.0 */ public TextArea(String caption, ValueChangeListener<String> valueChangeListener) { @@ -114,6 +116,7 @@ public class TextArea extends AbstractTextField { * the value for the field, not {@code null} * @param valueChangeListener * the value change listener, not {@code null} + * @since 8.0 */ public TextArea(String caption, String value, ValueChangeListener<String> valueChangeListener) { diff --git a/server/src/main/java/com/vaadin/ui/TwinColSelect.java b/server/src/main/java/com/vaadin/ui/TwinColSelect.java index 1b84e32fe0..d0c32f0a3b 100644 --- a/server/src/main/java/com/vaadin/ui/TwinColSelect.java +++ b/server/src/main/java/com/vaadin/ui/TwinColSelect.java @@ -59,6 +59,7 @@ public class TwinColSelect<T> extends AbstractMultiSelect<T> * the caption to set, can be {@code null} * @param dataProvider * the data provider, not {@code null} + * @since 8.0 */ public TwinColSelect(String caption, DataProvider<T, ?> dataProvider) { this(caption); diff --git a/server/src/main/java/com/vaadin/ui/UI.java b/server/src/main/java/com/vaadin/ui/UI.java index 00ccf2b0e2..82d3c82196 100644 --- a/server/src/main/java/com/vaadin/ui/UI.java +++ b/server/src/main/java/com/vaadin/ui/UI.java @@ -968,6 +968,7 @@ public abstract class UI extends AbstractSingleComponentContainer * @param listener * The listener to add, not null * @return a registration object for removing the listener + * @since 8.0 */ public Registration addClickListener(ClickListener listener) { return addListener(EventId.CLICK_EVENT_IDENTIFIER, ClickEvent.class, @@ -1794,7 +1795,7 @@ public abstract class UI extends AbstractSingleComponentContainer * * @param listener * the WindowModeChangeListener to add. - * @since 8.0.0 + * @since 8.0 * * @return a registration object for removing the listener */ @@ -1815,7 +1816,7 @@ public abstract class UI extends AbstractSingleComponentContainer * @see Window.WindowOrderChangeEvent * * @author Vaadin Ltd - * @since 8.0.0 + * @since 8.0 * */ public static class WindowOrderUpdateEvent extends Component.Event { @@ -1842,7 +1843,7 @@ public abstract class UI extends AbstractSingleComponentContainer /** * An interface used for listening to Windows order update events. * - * @since 8.0.0 + * @since 8.0 * * @see Window.WindowOrderChangeEvent */ diff --git a/server/src/main/java/com/vaadin/ui/Upload.java b/server/src/main/java/com/vaadin/ui/Upload.java index d725d157a6..27029f20de 100644 --- a/server/src/main/java/com/vaadin/ui/Upload.java +++ b/server/src/main/java/com/vaadin/ui/Upload.java @@ -634,6 +634,7 @@ public class Upload extends AbstractComponent * * @param listener * the Listener to be added, not null + * @since 8.0 */ public Registration addStartedListener(StartedListener listener) { return addListener(StartedEvent.class, listener, UPLOAD_STARTED_METHOD); @@ -655,6 +656,7 @@ public class Upload extends AbstractComponent * * @param listener * the Listener to be added, not null + * @since 8.0 */ public Registration addFinishedListener(FinishedListener listener) { return addListener(FinishedEvent.class, listener, @@ -677,6 +679,7 @@ public class Upload extends AbstractComponent * * @param listener * the Listener to be added, not null + * @since 8.0 */ public Registration addFailedListener(FailedListener listener) { return addListener(FailedEvent.class, listener, UPLOAD_FAILED_METHOD); @@ -698,6 +701,7 @@ public class Upload extends AbstractComponent * * @param listener * the Listener to be added, not null + * @since 8.0 */ public Registration addSucceededListener(SucceededListener listener) { return addListener(SucceededEvent.class, listener, @@ -720,6 +724,7 @@ public class Upload extends AbstractComponent * * @param listener * the progress listener to be added + * @since 8.0 */ public Registration addProgressListener(ProgressListener listener) { Objects.requireNonNull(listener, "Listener must not be null."); @@ -752,6 +757,7 @@ public class Upload extends AbstractComponent * * @param listener * the Listener to add, not null + * @since 8.0 */ public Registration addChangeListener(ChangeListener listener) { return addListener(EventId.CHANGE, ChangeEvent.class, listener, @@ -1136,6 +1142,7 @@ public class Upload extends AbstractComponent * * @param immediateMode * {@code true} for immediate mode, {@code false} for not + * @since 8.0 */ public void setImmediateMode(boolean immediateMode) { getState().immediateMode = immediateMode; @@ -1149,6 +1156,7 @@ public class Upload extends AbstractComponent * @return {@code true} if the upload is in immediate mode, {@code false} if * the upload is not in immediate mode * @see #setImmediateMode(boolean) + * @since 8.0 */ public boolean isImmediateMode() { return getState(false).immediateMode; diff --git a/server/src/main/java/com/vaadin/ui/VerticalLayout.java b/server/src/main/java/com/vaadin/ui/VerticalLayout.java index b012d46aa8..bafbfe315a 100644 --- a/server/src/main/java/com/vaadin/ui/VerticalLayout.java +++ b/server/src/main/java/com/vaadin/ui/VerticalLayout.java @@ -75,6 +75,7 @@ public class VerticalLayout extends AbstractOrderedLayout { * * @param components * the components to set, not <code>null</code> + * @since 8.0 */ public void addComponentsAndExpand(Component... components) { addComponents(components); diff --git a/server/src/main/java/com/vaadin/ui/Window.java b/server/src/main/java/com/vaadin/ui/Window.java index 7b57927d94..211f4f4e20 100644 --- a/server/src/main/java/com/vaadin/ui/Window.java +++ b/server/src/main/java/com/vaadin/ui/Window.java @@ -338,7 +338,7 @@ public class Window extends Panel * * @see UI#addWindowOrderUpdateListener(com.vaadin.ui.UI.WindowOrderUpdateListener) * - * @since 8.0.0 + * @since 8.0 * * @return window order position. */ @@ -468,6 +468,7 @@ public class Window extends Panel * * @param listener * the WindowModeChangeListener to add. + * @since 8.0 */ public Registration addWindowOrderChangeListener( WindowOrderChangeListener listener) { @@ -528,6 +529,7 @@ public class Window extends Panel * * @param listener * the CloseListener to add, not null + * @since 8.0 */ public Registration addCloseListener(CloseListener listener) { return addListener(CloseEvent.class, listener, WINDOW_CLOSE_METHOD); @@ -627,6 +629,7 @@ public class Window extends Panel * * @param listener * the WindowModeChangeListener to add. + * @since 8.0 */ public Registration addWindowModeChangeListener( WindowModeChangeListener listener) { @@ -710,6 +713,7 @@ public class Window extends Panel * @param listener * the listener to add, not null * @return a registration object for removing the listener + * @since 8.0 */ public Registration addResizeListener(ResizeListener listener) { return addListener(ResizeEvent.class, listener, WINDOW_RESIZE_METHOD); diff --git a/server/src/main/java/com/vaadin/ui/components/grid/EditorImpl.java b/server/src/main/java/com/vaadin/ui/components/grid/EditorImpl.java index 51cf1433b2..b771696aa2 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/EditorImpl.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/EditorImpl.java @@ -45,6 +45,7 @@ import elemental.json.JsonObject; * * @param <T> * the grid bean type + * @since 8.0 */ public class EditorImpl<T> extends AbstractGridExtension<T> implements Editor<T> { @@ -347,4 +348,4 @@ public class EditorImpl<T> extends AbstractGridExtension<T> public Grid<T> getGrid() { return getParent(); } -}
\ No newline at end of file +} diff --git a/server/src/main/java/com/vaadin/ui/declarative/DesignAttributeHandler.java b/server/src/main/java/com/vaadin/ui/declarative/DesignAttributeHandler.java index 8207ce7af6..57bfde47fb 100644 --- a/server/src/main/java/com/vaadin/ui/declarative/DesignAttributeHandler.java +++ b/server/src/main/java/com/vaadin/ui/declarative/DesignAttributeHandler.java @@ -197,6 +197,7 @@ public class DesignAttributeHandler implements Serializable { * the attribute list where the attribute will be written * @param defaultInstance * the default instance for comparing default values + * @since 8.0 */ @SuppressWarnings({ "unchecked", "rawtypes" }) public static void writeAttribute(Object component, String attribute, @@ -236,6 +237,7 @@ public class DesignAttributeHandler implements Serializable { * the default attribute value * @param inputType * the type of the input value + * @since 8.0 */ public static <T> void writeAttribute(String attribute, Attributes attributes, T value, T defaultValue, Class<T> inputType, diff --git a/server/src/main/java/com/vaadin/ui/declarative/DesignFormatter.java b/server/src/main/java/com/vaadin/ui/declarative/DesignFormatter.java index 0f40be795b..41efce25dd 100644 --- a/server/src/main/java/com/vaadin/ui/declarative/DesignFormatter.java +++ b/server/src/main/java/com/vaadin/ui/declarative/DesignFormatter.java @@ -195,6 +195,7 @@ public class DesignFormatter implements Serializable { * Type to convert to/from. * @param converter * Converter. + * @since 8.0 */ protected <T> void addConverter(Class<?> type, Converter<String, ?> converter) { @@ -301,6 +302,7 @@ public class DesignFormatter implements Serializable { * be returned. * @return A valid converter for a given type or its supertype, <b>null</b> * if it was not found. + * @since 8.0 */ @SuppressWarnings({ "unchecked", "rawtypes" }) protected <T> Converter<String, T> findConverterFor( @@ -336,6 +338,7 @@ public class DesignFormatter implements Serializable { * Type to find a converter for. * @return A valid converter for a given type or its subtype, <b>null</b> if * it was not found. + * @since 8.0 */ protected <T> Converter<String, T> findConverterFor( Class<? extends T> sourceType) { diff --git a/server/src/main/java/com/vaadin/ui/renderers/AbstractRenderer.java b/server/src/main/java/com/vaadin/ui/renderers/AbstractRenderer.java index d34c6d6ba6..d8c112110d 100644 --- a/server/src/main/java/com/vaadin/ui/renderers/AbstractRenderer.java +++ b/server/src/main/java/com/vaadin/ui/renderers/AbstractRenderer.java @@ -40,6 +40,7 @@ import elemental.json.JsonValue; * the grid type this renderer can be attached to * @param <V> * the type this renderer knows how to present + * @since 8.0 */ public abstract class AbstractRenderer<T, V> extends AbstractExtension implements Renderer<V> { diff --git a/server/src/main/java/com/vaadin/ui/renderers/ClickableRenderer.java b/server/src/main/java/com/vaadin/ui/renderers/ClickableRenderer.java index 53d510497d..8af57542de 100644 --- a/server/src/main/java/com/vaadin/ui/renderers/ClickableRenderer.java +++ b/server/src/main/java/com/vaadin/ui/renderers/ClickableRenderer.java @@ -86,6 +86,7 @@ public abstract class ClickableRenderer<T, V> extends AbstractRenderer<T, V> { * Returns the item of the row where the click event originated. * * @return the item of the clicked row + * @since 8.0 */ public T getItem() { return item; @@ -145,6 +146,7 @@ public abstract class ClickableRenderer<T, V> extends AbstractRenderer<T, V> { * * @param listener * the click listener to be added, not null + * @since 8.0 */ public Registration addClickListener(RendererClickListener<T> listener) { return addListener(RendererClickEvent.class, listener, diff --git a/server/src/main/java/com/vaadin/util/CurrentInstance.java b/server/src/main/java/com/vaadin/util/CurrentInstance.java index df23f6c8bc..8c3d93993a 100644 --- a/server/src/main/java/com/vaadin/util/CurrentInstance.java +++ b/server/src/main/java/com/vaadin/util/CurrentInstance.java @@ -215,7 +215,7 @@ public class CurrentInstance implements Serializable { * Gets the currently set instances so that they can later be restored using * {@link #restoreInstances(Map)}. * - * @since 7.1 + * @since 8.0 * * @return a map containing the current instances */ diff --git a/server/src/main/java/com/vaadin/util/ReflectTools.java b/server/src/main/java/com/vaadin/util/ReflectTools.java index beda104230..8ff8ddcbb0 100644 --- a/server/src/main/java/com/vaadin/util/ReflectTools.java +++ b/server/src/main/java/com/vaadin/util/ReflectTools.java @@ -226,7 +226,7 @@ public class ReflectTools implements Serializable { * another class to get the base type for, not <code>null</code> * @return the most specific base class, not <code>null</code> * - * @since + * @since 8.0 */ public static Class<?> findCommonBaseType(Class<?> a, Class<?> b) { if (a.isInterface()) { |