diff options
| author | Ilia Motornyi <elmot@vaadin.com> | 2017-01-02 11:32:29 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-01-02 11:32:29 +0200 |
| commit | 0740ac116e637d81bd7e2415746f020dd25102e6 (patch) | |
| tree | 4772a51026f12abda69ae10a23f97619330dff34 | |
| parent | a25b690f1d188753fa0f202d862fe9f117e02b7e (diff) | |
| download | vaadin-framework-0740ac116e637d81bd7e2415746f020dd25102e6.tar.gz vaadin-framework-0740ac116e637d81bd7e2415746f020dd25102e6.zip | |
Partial javadocs fix for vaadin-server
62 files changed, 105 insertions, 182 deletions
diff --git a/server/src/main/java/com/vaadin/data/Binder.java b/server/src/main/java/com/vaadin/data/Binder.java index 5cde210189..fab163a1c5 100644 --- a/server/src/main/java/com/vaadin/data/Binder.java +++ b/server/src/main/java/com/vaadin/data/Binder.java @@ -110,7 +110,7 @@ public class Binder<BEAN> implements Serializable { * instance representing the outcome of the validation. * * @see Binder#validate() - * @see Validator#apply(Object) + * @see Validator#apply(Object, ValueContext) * * @return the validation result. */ @@ -805,8 +805,7 @@ public class Binder<BEAN> implements Serializable { /** * Handles the value change triggered by the bound field. * - * @param bean - * the new value + * @param event */ private void handleFieldValueChange( ValueChangeEvent<FIELDVALUE> event) { @@ -1020,7 +1019,7 @@ public class Binder<BEAN> implements Serializable { * {@link HasValue#getEmptyValue()}. This conversion is one-way only, if you * want to have a two-way mapping back to {@code null}, use * {@link #forField(HasValue)} and - * {@link Binding#withNullRepresentation(Object))}. + * {@link BindingBuilder#withNullRepresentation(Object))}. * <p> * When a bean is bound with {@link Binder#setBean(BEAN)}, the field value * is set to the return value of the given getter. The property value is @@ -1384,13 +1383,13 @@ public class Binder<BEAN> implements Serializable { * Only the one validation error message is shown in this label at a time. * <p> * This is a convenience method for - * {@link #setValidationStatusHandler(BinderStatusHandler)}, which means + * {@link #setValidationStatusHandler(BinderValidationStatusHandler)}, which means * that this method cannot be used after the handler has been set. Also the * handler cannot be set after this label has been set. * * @param statusLabel * the status label to set - * @see #setValidationStatusHandler(BinderStatusHandler) + * @see #setValidationStatusHandler(BinderValidationStatusHandler) * @see BindingBuilder#withStatusLabel(Label) */ public void setStatusLabel(Label statusLabel) { @@ -1447,11 +1446,11 @@ public class Binder<BEAN> implements Serializable { * Gets the status handler of this form. * <p> * If none has been set with - * {@link #setValidationStatusHandler(BinderStatusHandler)}, the default + * {@link #setValidationStatusHandler(BinderValidationStatusHandler)}, the default * implementation is returned. * * @return the status handler used, never <code>null</code> - * @see #setValidationStatusHandler(BinderStatusHandler) + * @see #setValidationStatusHandler(BinderValidationStatusHandler) */ public BinderValidationStatusHandler<BEAN> getValidationStatusHandler() { return Optional.ofNullable(statusHandler) diff --git a/server/src/main/java/com/vaadin/data/BinderValidationStatus.java b/server/src/main/java/com/vaadin/data/BinderValidationStatus.java index f89b743258..663d1635df 100644 --- a/server/src/main/java/com/vaadin/data/BinderValidationStatus.java +++ b/server/src/main/java/com/vaadin/data/BinderValidationStatus.java @@ -29,12 +29,12 @@ import com.vaadin.data.validator.BeanValidator; * Binder validation status change. Represents the outcome of binder level * validation. Has information about the validation results for the * {@link BindingBuilder#withValidator(Validator) field level} and - * {@link Binder#withValidator(Validator)binder level} validation. + * {@link Binder#withValidator(Validator) binder level} validation. * <p> * Note: if there are any field level validation errors, the bean level * validation is not run. * <p> - * Use {@link Binder#setValidationStatusHandler(BinderStatusHandler)} to handle + * Use {@link Binder#setValidationStatusHandler(BinderValidationStatusHandler)} to handle * form level validation status changes. * * @author Vaadin Ltd @@ -43,7 +43,7 @@ import com.vaadin.data.validator.BeanValidator; * the bean type of the binder * * @see BinderValidationStatusHandler - * @see Binder#setValidationStatusHandler(BinderStatusHandler) + * @see Binder#setValidationStatusHandler(BinderValidationStatusHandler) * @see Binder#validate() * @see BindingValidationStatus * diff --git a/server/src/main/java/com/vaadin/data/BinderValidationStatusHandler.java b/server/src/main/java/com/vaadin/data/BinderValidationStatusHandler.java index c2b591cf25..9f144ac430 100644 --- a/server/src/main/java/com/vaadin/data/BinderValidationStatusHandler.java +++ b/server/src/main/java/com/vaadin/data/BinderValidationStatusHandler.java @@ -21,7 +21,7 @@ import com.vaadin.ui.AbstractComponent; /** * Handler for {@link BinderValidationStatus} changes. * <p> - * {{@link Binder#setValidationStatusHandler(BinderStatusHandler) Register} an + * {@link Binder#setValidationStatusHandler(BinderValidationStatusHandler) Register} an * instance of this class to be able to customize validation status handling. * <p> * The default handler will show diff --git a/server/src/main/java/com/vaadin/data/BindingValidationStatusHandler.java b/server/src/main/java/com/vaadin/data/BindingValidationStatusHandler.java index 74a4c41c66..6e509be0ac 100644 --- a/server/src/main/java/com/vaadin/data/BindingValidationStatusHandler.java +++ b/server/src/main/java/com/vaadin/data/BindingValidationStatusHandler.java @@ -22,7 +22,7 @@ import com.vaadin.ui.AbstractComponent; /** * Handler for {@link BindingValidationStatus} changes. * <p> - * {@link BindingBuilder#withValidationStatusHandler(withValidationStatusHandler) + * {@link BindingBuilder#withValidationStatusHandler(BindingValidationStatusHandler)} * Register} an instance of this class to be able to override the default * handling, which is to show * {@link AbstractComponent#setComponentError(com.vaadin.server.ErrorMessage) an @@ -30,7 +30,7 @@ import com.vaadin.ui.AbstractComponent; * * @author Vaadin Ltd * - * @see BindingBuilder#withValidationStatusHandler(withValidationStatusHandler) + * @see BindingBuilder#withValidationStatusHandler(BindingValidationStatusHandler) * @see BindingValidationStatus * * @since 8.0 diff --git a/server/src/main/java/com/vaadin/data/HasValue.java b/server/src/main/java/com/vaadin/data/HasValue.java index 22cc1c30bc..b5707605cd 100644 --- a/server/src/main/java/com/vaadin/data/HasValue.java +++ b/server/src/main/java/com/vaadin/data/HasValue.java @@ -19,8 +19,7 @@ import java.io.Serializable; import java.lang.reflect.Method; import java.util.EventObject; import java.util.Objects; -import java.util.function.BiConsumer; - +import com.vaadin.server.Setter; import com.vaadin.event.SerializableEventListener; import com.vaadin.shared.Registration; import com.vaadin.ui.Component; @@ -200,7 +199,7 @@ public interface HasValue<V> extends Serializable { * values. Specific implementations might not support this. * * @return empty value - * @see Binder#bind(HasValue, ValueProvider, BiConsumer) + * @see Binder#bind(HasValue, ValueProvider, Setter) */ public default V getEmptyValue() { return null; diff --git a/server/src/main/java/com/vaadin/data/ValidationException.java b/server/src/main/java/com/vaadin/data/ValidationException.java index 3122614b36..6b3b0a121a 100644 --- a/server/src/main/java/com/vaadin/data/ValidationException.java +++ b/server/src/main/java/com/vaadin/data/ValidationException.java @@ -82,7 +82,7 @@ public class ValidationException extends Exception { /** * Returns a list of the bean level validation errors which caused the * exception, or an empty list if the exception was caused by - * {@link #getBindingValidationErrors() binder level validation errors}. + * {@link #getFieldValidationErrors() field level validation errors}. * * @return binder validation errors list */ diff --git a/server/src/main/java/com/vaadin/data/converter/AbstractStringToNumberConverter.java b/server/src/main/java/com/vaadin/data/converter/AbstractStringToNumberConverter.java index 2aefb43567..1c4d95cfe0 100644 --- a/server/src/main/java/com/vaadin/data/converter/AbstractStringToNumberConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/AbstractStringToNumberConverter.java @@ -52,8 +52,8 @@ public abstract class AbstractStringToNumberConverter<T> } /** - * Returns the format used by {@link #convertToPresentation(Object, Locale)} - * and {@link #convertToModel(Object, Locale)}. + * Returns the format used by {@link #convertToPresentation(Object, ValueContext)} + * and {@link #convertToModel(Object, ValueContext)}. * * @param locale * The locale to use diff --git a/server/src/main/java/com/vaadin/data/converter/StringToBooleanConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToBooleanConverter.java index 67dca5c558..49fa043a86 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToBooleanConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToBooleanConverter.java @@ -25,7 +25,7 @@ import com.vaadin.data.ValueContext; /** * A converter that converts from {@link String} to {@link Boolean} and back. * The String representation is given by {@link Boolean#toString()} or provided - * in constructor {@link #StringToBooleanConverter(String, String)}. + * in constructor {@link StringToBooleanConverter#StringToBooleanConverter(String, String, String)}. * <p> * Leading and trailing white spaces are ignored when converting from a String. * </p> @@ -109,7 +109,7 @@ public class StringToBooleanConverter implements Converter<String, Boolean> { /** * Gets the locale-depended string representation for false. Default is - * locale-independent value provided by {@link #getFalseString()} + * locale-independent value {@code false} * * @param locale * to be used @@ -121,7 +121,7 @@ public class StringToBooleanConverter implements Converter<String, Boolean> { /** * Gets the locale-depended string representation for true. Default is - * locale-independent value provided by {@link #getTrueString()} + * locale-independent value {@code true} * * @param locale * to be used diff --git a/server/src/main/java/com/vaadin/data/converter/StringToDateConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToDateConverter.java index 790d3cb762..ffed8cf10b 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToDateConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToDateConverter.java @@ -41,8 +41,8 @@ import com.vaadin.data.ValueContext; public class StringToDateConverter implements Converter<String, Date> { /** - * Returns the format used by {@link #convertToPresentation(Date, Locale)} - * and {@link #convertToModel(String, Locale)}. + * Returns the format used by {@link #convertToPresentation(Date, ValueContext)} + * and {@link #convertToModel(String, ValueContext)}. * * @param locale * The locale to use diff --git a/server/src/main/java/com/vaadin/data/converter/StringToIntegerConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToIntegerConverter.java index c54903ef8e..bb64218ba0 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToIntegerConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToIntegerConverter.java @@ -48,8 +48,8 @@ public class StringToIntegerConverter /** * Returns the format used by - * {@link #convertToPresentation(Integer, Locale)} and - * {@link #convertToModel(String, Locale)}. + * {@link #convertToPresentation(Object, ValueContext)} and + * {@link #convertToModel(String, ValueContext)}. * * @param locale * The locale to use diff --git a/server/src/main/java/com/vaadin/data/converter/StringToLongConverter.java b/server/src/main/java/com/vaadin/data/converter/StringToLongConverter.java index 8ddacdedfe..129e1aefea 100644 --- a/server/src/main/java/com/vaadin/data/converter/StringToLongConverter.java +++ b/server/src/main/java/com/vaadin/data/converter/StringToLongConverter.java @@ -47,8 +47,8 @@ public class StringToLongConverter } /** - * Returns the format used by {@link #convertToPresentation(Long, Locale)} - * and {@link #convertToModel(String, Locale)}. + * Returns the format used by {@link #convertToPresentation(Object, ValueContext)} + * and {@link #convertToModel(String, ValueContext)}. * * @param locale * The locale to use 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 40bf9e0880..7cd6b7390f 100644 --- a/server/src/main/java/com/vaadin/data/provider/DataCommunicator.java +++ b/server/src/main/java/com/vaadin/data/provider/DataCommunicator.java @@ -84,8 +84,8 @@ public class DataCommunicator<T, F> extends AbstractExtension { * {@link DataKeyMapper}. * <p> * When the {@link DataCommunicator} is pushing new data to the client-side - * via {@link DataCommunicator#pushData(long, Collection)}, - * {@link #addActiveData(Collection)} and {@link #cleanUp(Collection)} are + * via {@link DataCommunicator#pushData(int, Stream)}, + * {@link #addActiveData(Stream)} and {@link #cleanUp(Stream)} are * called with the same parameter. In the clean up method any dropped data * objects that are not in the given collection will be cleaned up and * {@link DataGenerator#destroyData(Object)} will be called for them. diff --git a/server/src/main/java/com/vaadin/event/ContextClickEvent.java b/server/src/main/java/com/vaadin/event/ContextClickEvent.java index c1c779bd28..ba62a2ec14 100644 --- a/server/src/main/java/com/vaadin/event/ContextClickEvent.java +++ b/server/src/main/java/com/vaadin/event/ContextClickEvent.java @@ -18,7 +18,6 @@ package com.vaadin.event; import java.io.Serializable; import java.lang.reflect.Method; -import com.vaadin.event.FieldEvents.FocusListener; import com.vaadin.event.MouseEvents.ClickEvent; import com.vaadin.shared.MouseEventDetails; import com.vaadin.shared.Registration; @@ -85,7 +84,7 @@ public class ContextClickEvent extends ClickEvent { * * @deprecated As of 8.0, replaced by {@link Registration#remove()} in * the registration object returned from - * {@link #addContextClickListener(FocusListener)}. + * {@link #addContextClickListener(ContextClickListener)} . */ @Deprecated public void removeContextClickListener(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 fec20f8d6f..75f8b38ff9 100644 --- a/server/src/main/java/com/vaadin/event/FieldEvents.java +++ b/server/src/main/java/com/vaadin/event/FieldEvents.java @@ -28,7 +28,7 @@ import com.vaadin.ui.Component.Event; import com.vaadin.util.ReflectTools; /** - * Interface that serves as a wrapper for {@link Field} related events. + * Interface that serves as a wrapper for focus and blur events. */ public interface FieldEvents { diff --git a/server/src/main/java/com/vaadin/event/MouseEvents.java b/server/src/main/java/com/vaadin/event/MouseEvents.java index ad807ec21e..76f14d0840 100644 --- a/server/src/main/java/com/vaadin/event/MouseEvents.java +++ b/server/src/main/java/com/vaadin/event/MouseEvents.java @@ -46,17 +46,17 @@ public interface MouseEvents { */ public static class ClickEvent extends Component.Event { /** - * @deprecated As of 7.0, use {@link Button#LEFT} instead. + * @deprecated As of 7.0, use {@link MouseButton#LEFT} instead. */ @Deprecated public static final MouseButton BUTTON_LEFT = MouseButton.LEFT; /** - * @deprecated As of 7.0, use {@link Button#MIDDLE} instead. + * @deprecated As of 7.0, use {@link MouseButton#MIDDLE} instead. */ @Deprecated public static final MouseButton BUTTON_MIDDLE = MouseButton.MIDDLE; /** - * @deprecated As of 7.0, use {@link Button#RIGHT} instead. + * @deprecated As of 7.0, use {@link MouseButton#RIGHT} instead. */ @Deprecated public static final MouseButton BUTTON_RIGHT = MouseButton.RIGHT; @@ -71,7 +71,7 @@ public interface MouseEvents { /** * Returns an identifier describing which mouse button the user pushed. * Compare with {@link MouseButton#LEFT},{@link MouseButton#MIDDLE}, - * {@link Button#RIGHT} to find out which button it is. + * {@link MouseButton#RIGHT} to find out which button it is. * * @return one of {@link MouseButton#LEFT}, {@link MouseButton#MIDDLE}, * {@link MouseButton#RIGHT}. diff --git a/server/src/main/java/com/vaadin/event/SortEvent.java b/server/src/main/java/com/vaadin/event/SortEvent.java index 23182fcfb0..b6948fd711 100644 --- a/server/src/main/java/com/vaadin/event/SortEvent.java +++ b/server/src/main/java/com/vaadin/event/SortEvent.java @@ -18,12 +18,13 @@ package com.vaadin.event; import java.io.Serializable; import java.util.List; +import com.vaadin.data.provider.DataProvider; import com.vaadin.data.provider.SortOrder; import com.vaadin.shared.Registration; import com.vaadin.ui.Component; /** - * Event describing a change in sorting of a {@link Container}. Fired by + * Event describing a change in sorting of a {@link DataProvider}. Fired by * {@link SortNotifier SortNotifiers}. * * @see SortListener diff --git a/server/src/main/java/com/vaadin/event/selection/MultiSelectionListener.java b/server/src/main/java/com/vaadin/event/selection/MultiSelectionListener.java index 653ae67979..96c3aa3f50 100644 --- a/server/src/main/java/com/vaadin/event/selection/MultiSelectionListener.java +++ b/server/src/main/java/com/vaadin/event/selection/MultiSelectionListener.java @@ -31,7 +31,7 @@ import com.vaadin.util.ReflectTools; * @param <T> * the type of the selected item * - * @see SelectionModel.Multi + * @see com.vaadin.data.SelectionModel.Multi * @see MultiSelectionEvent */ @FunctionalInterface diff --git a/server/src/main/java/com/vaadin/event/selection/SingleSelectionEvent.java b/server/src/main/java/com/vaadin/event/selection/SingleSelectionEvent.java index b9f03891a5..89f30e1869 100644 --- a/server/src/main/java/com/vaadin/event/selection/SingleSelectionEvent.java +++ b/server/src/main/java/com/vaadin/event/selection/SingleSelectionEvent.java @@ -20,6 +20,7 @@ import java.util.Optional; import java.util.Set; import com.vaadin.data.HasValue.ValueChangeEvent; +import com.vaadin.data.SelectionModel; import com.vaadin.ui.AbstractSingleSelect; import com.vaadin.ui.Component; import com.vaadin.ui.SingleSelect; diff --git a/server/src/main/java/com/vaadin/event/selection/SingleSelectionListener.java b/server/src/main/java/com/vaadin/event/selection/SingleSelectionListener.java index e52b780ccf..b5683affe6 100644 --- a/server/src/main/java/com/vaadin/event/selection/SingleSelectionListener.java +++ b/server/src/main/java/com/vaadin/event/selection/SingleSelectionListener.java @@ -17,6 +17,7 @@ package com.vaadin.event.selection; import java.lang.reflect.Method; +import com.vaadin.data.SelectionModel; import com.vaadin.event.SerializableEventListener; import com.vaadin.util.ReflectTools; diff --git a/server/src/main/java/com/vaadin/navigator/NavigationStateManager.java b/server/src/main/java/com/vaadin/navigator/NavigationStateManager.java index b4f4c4ced0..1d36fbbe5b 100644 --- a/server/src/main/java/com/vaadin/navigator/NavigationStateManager.java +++ b/server/src/main/java/com/vaadin/navigator/NavigationStateManager.java @@ -47,7 +47,7 @@ public interface NavigationStateManager extends Serializable { * <p> * This method should be only called by a Navigator. * - * @param fragment + * @param state * new view and parameter string, not null */ public void setState(String state); diff --git a/server/src/main/java/com/vaadin/navigator/Navigator.java b/server/src/main/java/com/vaadin/navigator/Navigator.java index 163db74feb..d403b48690 100644 --- a/server/src/main/java/com/vaadin/navigator/Navigator.java +++ b/server/src/main/java/com/vaadin/navigator/Navigator.java @@ -1021,7 +1021,6 @@ public class Navigator implements Serializable { * {@code parameters}. * * @since 7.6.7 - * @return view change event */ public void destroy() { stateManager.setNavigator(null); diff --git a/server/src/main/java/com/vaadin/server/BootstrapFragmentResponse.java b/server/src/main/java/com/vaadin/server/BootstrapFragmentResponse.java index 0e4fe7977a..23928cdeac 100644 --- a/server/src/main/java/com/vaadin/server/BootstrapFragmentResponse.java +++ b/server/src/main/java/com/vaadin/server/BootstrapFragmentResponse.java @@ -36,8 +36,7 @@ public class BootstrapFragmentResponse extends BootstrapResponse { /** * Crate a new bootstrap fragment response. * - * @see BootstrapResponse#BootstrapResponse(BootstrapHandler, VaadinRequest, - * VaadinSession, Class) + * @see BootstrapResponse#BootstrapResponse(BootstrapHandler, VaadinRequest, VaadinSession, Class, UIProvider) * * @param handler * the bootstrap handler that is firing the event diff --git a/server/src/main/java/com/vaadin/server/BootstrapPageResponse.java b/server/src/main/java/com/vaadin/server/BootstrapPageResponse.java index d8b21bb815..22fadbe552 100644 --- a/server/src/main/java/com/vaadin/server/BootstrapPageResponse.java +++ b/server/src/main/java/com/vaadin/server/BootstrapPageResponse.java @@ -38,8 +38,7 @@ public class BootstrapPageResponse extends BootstrapResponse { /** * Crate a new bootstrap page response. * - * @see BootstrapResponse#BootstrapResponse(BootstrapHandler, VaadinRequest, - * VaadinSession, Class) + * @see BootstrapResponse#BootstrapResponse(BootstrapHandler, VaadinRequest, VaadinSession, Class, UIProvider) * * @param handler * the bootstrap handler that is firing the event diff --git a/server/src/main/java/com/vaadin/server/BootstrapResponse.java b/server/src/main/java/com/vaadin/server/BootstrapResponse.java index 4af93346ca..9b1a86e139 100644 --- a/server/src/main/java/com/vaadin/server/BootstrapResponse.java +++ b/server/src/main/java/com/vaadin/server/BootstrapResponse.java @@ -70,7 +70,7 @@ public abstract class BootstrapResponse extends EventObject { /** * Gets the request for which the generated bootstrap HTML will be the * response. This can be used to read request headers and other additional - * information. Please note that {@link VaadinRequest#getBrowserDetails()} + * information. Please note that {@link VaadinSession#getBrowser()} * will not be available because the bootstrap page is generated before the * bootstrap javascript has had a chance to send any information back to the * server. diff --git a/server/src/main/java/com/vaadin/server/ClientConnector.java b/server/src/main/java/com/vaadin/server/ClientConnector.java index c2e96d9fc1..97a14bc5c8 100644 --- a/server/src/main/java/com/vaadin/server/ClientConnector.java +++ b/server/src/main/java/com/vaadin/server/ClientConnector.java @@ -110,8 +110,7 @@ public interface ClientConnector extends Connector { /** * An error event for connector related errors. Use {@link #getConnector()} - * to find the connector where the error occurred or {@link #getComponent()} - * to find the nearest parent component. + * to find the connector where the error occurred. */ public static class ConnectorErrorEvent extends com.vaadin.server.ErrorEvent { diff --git a/server/src/main/java/com/vaadin/server/ErrorEvent.java b/server/src/main/java/com/vaadin/server/ErrorEvent.java index bf9014587f..7660da861a 100644 --- a/server/src/main/java/com/vaadin/server/ErrorEvent.java +++ b/server/src/main/java/com/vaadin/server/ErrorEvent.java @@ -109,8 +109,8 @@ public class ErrorEvent implements Serializable { /** * Method for finding the error handler for the given session. * - * @param connector - * The target connector + * @param session + * The target session * * @return An ErrorHandler for the session or null if none was found */ diff --git a/server/src/main/java/com/vaadin/server/JsonCodec.java b/server/src/main/java/com/vaadin/server/JsonCodec.java index 001961ca37..9c105d505e 100644 --- a/server/src/main/java/com/vaadin/server/JsonCodec.java +++ b/server/src/main/java/com/vaadin/server/JsonCodec.java @@ -367,13 +367,9 @@ public class JsonCodec implements Serializable { * * @param targetType * The type that should be returned by this method - * @param valueAndType - * The encoded value and type array - * @param application - * A reference to the application - * @param enforceGenericsInCollections - * true if generics should be enforce, false to only allow - * internal types in collections + * @param restrictToInternalTypes + * @param encodedJsonValue + * @param connectorTracker * @return */ public static Object decodeInternalType(Type targetType, @@ -550,8 +546,8 @@ public class JsonCodec implements Serializable { * @param typeIndex * The index of a generic type to use to define the child type * that should be decoded - * @param encodedValueAndType - * @param application + * @param connectorTracker + * @param value * @return */ private static Object decodeParametrizedType(Type targetType, diff --git a/server/src/main/java/com/vaadin/server/LegacyApplication.java b/server/src/main/java/com/vaadin/server/LegacyApplication.java index 599d9bb385..fcb4d21805 100644 --- a/server/src/main/java/com/vaadin/server/LegacyApplication.java +++ b/server/src/main/java/com/vaadin/server/LegacyApplication.java @@ -154,15 +154,10 @@ public abstract class LegacyApplication implements ErrorHandler { private int namelessUIIndex = 0; /** - * Adds a new browser level window to this application. Please note that UI - * doesn't have a name that is used in the URL - to add a named window you - * should instead use {@link #addWindow(UI, String)} + * Adds a new browser level window to this application. * * @param uI * the UI window to add to the application - * @return returns the name that has been assigned to the window - * - * @see #addWindow(UI, String) */ public void addWindow(LegacyWindow uI) { if (uI.getName() == null) { @@ -178,7 +173,7 @@ public abstract class LegacyApplication implements ErrorHandler { /** * Removes the specified window from the application. This also removes all - * name mappings for the window (see {@link #addWindow(UI, String) and + * name mappings for the window (see {@link #addWindow(LegacyWindow)} and * #getWindowName(UI)}. * * <p> diff --git a/server/src/main/java/com/vaadin/server/LegacyCommunicationManager.java b/server/src/main/java/com/vaadin/server/LegacyCommunicationManager.java index 8d79da672b..f3a56a2c53 100644 --- a/server/src/main/java/com/vaadin/server/LegacyCommunicationManager.java +++ b/server/src/main/java/com/vaadin/server/LegacyCommunicationManager.java @@ -357,7 +357,7 @@ public class LegacyCommunicationManager implements Serializable { /** * - * @param paintable + * @param object * @return true if the given class was added to cache */ public boolean cache(Object object) { diff --git a/server/src/main/java/com/vaadin/server/LegacyPaint.java b/server/src/main/java/com/vaadin/server/LegacyPaint.java index 0a65c932ed..485561e1ab 100644 --- a/server/src/main/java/com/vaadin/server/LegacyPaint.java +++ b/server/src/main/java/com/vaadin/server/LegacyPaint.java @@ -37,7 +37,7 @@ public class LegacyPaint implements Serializable { * * <p> * <b>Do not override this to paint your component.</b> Override - * {@link #paintContent(PaintTarget)} instead. + * {@link LegacyComponent#paintContent(PaintTarget)} instead. * </p> * * diff --git a/server/src/main/java/com/vaadin/server/Page.java b/server/src/main/java/com/vaadin/server/Page.java index fb4f7384dc..c96114b3f7 100644 --- a/server/src/main/java/com/vaadin/server/Page.java +++ b/server/src/main/java/com/vaadin/server/Page.java @@ -47,7 +47,7 @@ public class Page implements Serializable { * Listener that gets notified when the size of the browser window * containing the uI has changed. * - * @see UI#addListener(BrowserWindowResizeListener) + * @see #addBrowserWindowResizeListener(BrowserWindowResizeListener) */ @FunctionalInterface public interface BrowserWindowResizeListener extends Serializable { @@ -533,7 +533,7 @@ public class Page implements Serializable { * * @deprecated As of 8.0, replaced by {@link Registration#remove()} in the * registration object returned from - * {@link #addUriFragmentChangedListener(FocusListener)}. + * {@link #addUriFragmentChangedListener(UriFragmentChangedListener)}. */ @Deprecated public void removeUriFragmentChangedListener( diff --git a/server/src/main/java/com/vaadin/server/communication/AtmospherePushConnection.java b/server/src/main/java/com/vaadin/server/communication/AtmospherePushConnection.java index 1189ff6023..92d675001b 100644 --- a/server/src/main/java/com/vaadin/server/communication/AtmospherePushConnection.java +++ b/server/src/main/java/com/vaadin/server/communication/AtmospherePushConnection.java @@ -229,8 +229,8 @@ public class AtmospherePushConnection implements PushConnection { } /** - * Associates this {@code AtmospherePushConnection} with the given - * {@AtmosphereResource} representing an established push connection. If + * Associates this {@link AtmospherePushConnection} with the given + * {@link AtmosphereResource} representing an established push connection. If * already connected, calls {@link #disconnect()} first. If there is a * deferred push, carries it out via the new connection. * diff --git a/server/src/main/java/com/vaadin/server/communication/FileUploadHandler.java b/server/src/main/java/com/vaadin/server/communication/FileUploadHandler.java index 9a219c5d93..4e0c41bbcb 100644 --- a/server/src/main/java/com/vaadin/server/communication/FileUploadHandler.java +++ b/server/src/main/java/com/vaadin/server/communication/FileUploadHandler.java @@ -655,7 +655,7 @@ public class FileUploadHandler implements RequestHandler { * Removes any possible path information from the filename and returns the * filename. Separators / and \\ are used. * - * @param name + * @param filename * @return */ private static String removePath(String filename) { diff --git a/server/src/main/java/com/vaadin/server/communication/MetadataWriter.java b/server/src/main/java/com/vaadin/server/communication/MetadataWriter.java index 6d5a026ff2..1c32555a9f 100644 --- a/server/src/main/java/com/vaadin/server/communication/MetadataWriter.java +++ b/server/src/main/java/com/vaadin/server/communication/MetadataWriter.java @@ -42,9 +42,6 @@ public class MetadataWriter implements Serializable { * The writer used. * @param repaintAll * Whether the client should repaint everything. - * @param analyzeLayouts - * Whether detected layout problems should be reported in client - * and server console. * @param async * True if this message is sent by the server asynchronously, * false if it is a response to a client message. diff --git a/server/src/main/java/com/vaadin/server/widgetsetutils/ClassPathExplorer.java b/server/src/main/java/com/vaadin/server/widgetsetutils/ClassPathExplorer.java index 7e7539b865..0ec39c9416 100644 --- a/server/src/main/java/com/vaadin/server/widgetsetutils/ClassPathExplorer.java +++ b/server/src/main/java/com/vaadin/server/widgetsetutils/ClassPathExplorer.java @@ -476,7 +476,7 @@ public class ClassPathExplorer { /** * Add a jar file to locations - see {@link #classpathLocations}. * - * @param name + * @param file * @param locations */ private static void includeJar(File file, Map<String, URL> locations) { diff --git a/server/src/main/java/com/vaadin/ui/AbsoluteLayout.java b/server/src/main/java/com/vaadin/ui/AbsoluteLayout.java index f296e23245..0fc5ee82c2 100644 --- a/server/src/main/java/com/vaadin/ui/AbsoluteLayout.java +++ b/server/src/main/java/com/vaadin/ui/AbsoluteLayout.java @@ -403,7 +403,7 @@ public class AbsoluteLayout extends AbstractLayout * * @param bottomValue * The value of the 'bottom' attribute - * @param units + * @param bottomUnits * The unit of the 'bottom' attribute. See UNIT_SYMBOLS for a * description of the available units. */ @@ -419,7 +419,7 @@ public class AbsoluteLayout extends AbstractLayout * * @param leftValue * The value of the 'left' attribute - * @param units + * @param leftUnits * The unit of the 'left' attribute. See UNIT_SYMBOLS for a * description of the available units. */ @@ -479,7 +479,7 @@ public class AbsoluteLayout extends AbstractLayout * * @param rightValue * The value of the 'right' attribute - * @see #setRightUnits(int) + * @see #setRightUnits(Unit) */ public void setRightValue(Float rightValue) { this.rightValue = rightValue; @@ -503,7 +503,7 @@ public class AbsoluteLayout extends AbstractLayout * * @param bottomValue * The value of the 'bottom' attribute - * @see #setBottomUnits(int) + * @see #setBottomUnits(Unit) */ public void setBottomValue(Float bottomValue) { this.bottomValue = bottomValue; @@ -527,7 +527,7 @@ public class AbsoluteLayout extends AbstractLayout * * @param leftValue * The value of the 'left' CSS-attribute - * @see #setLeftUnits(int) + * @see #setLeftUnits(Unit) */ public void setLeftValue(Float leftValue) { this.leftValue = leftValue; diff --git a/server/src/main/java/com/vaadin/ui/AbstractComponent.java b/server/src/main/java/com/vaadin/ui/AbstractComponent.java index 5d3412f454..88bdc6f3dc 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractComponent.java +++ b/server/src/main/java/com/vaadin/ui/AbstractComponent.java @@ -489,8 +489,7 @@ public abstract class AbstractComponent extends AbstractClientConnector /** * Sets the component's description. See {@link #getDescription()} for more - * information on what the description is. This method will trigger a - * {@link RepaintRequestEvent}. + * information on what the description is. * * The description is displayed as HTML in tooltips or directly in certain * components so care should be taken to avoid creating the possibility for @@ -1091,8 +1090,6 @@ public abstract class AbstractComponent extends AbstractClientConnector * * @param attributes * the design attributes - * @param defaultInstance - * instance of the class that has default sizing. */ private void readSize(Attributes attributes) { // read width @@ -1121,8 +1118,6 @@ public abstract class AbstractComponent extends AbstractClientConnector * Writes the size related attributes for the component if they differ from * the defaults * - * @param component - * the component * @param attributes * the attribute map where the attribute are written * @param defaultInstance @@ -1228,7 +1223,7 @@ public abstract class AbstractComponent extends AbstractClientConnector /** * Returns a collection of attributes that should not be handled by the - * basic implementation of the {@link readDesign} and {@link writeDesign} + * basic implementation of the {@link #readDesign(Element, DesignContext)} and {@link #writeDesign(Element, DesignContext)} * methods. Typically these are handled in a custom way in the overridden * versions of the above methods * diff --git a/server/src/main/java/com/vaadin/ui/AbstractListing.java b/server/src/main/java/com/vaadin/ui/AbstractListing.java index 97fa1f3516..cf285c1d96 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractListing.java +++ b/server/src/main/java/com/vaadin/ui/AbstractListing.java @@ -138,9 +138,6 @@ public abstract class AbstractListing<T> extends AbstractComponent /** * Creates a new {@code AbstractListing} with a default data communicator. * <p> - * <strong>Note:</strong> This constructor does not set a selection model - * for the new listing. The invoking constructor must explicitly call - * {@link #setSelectionModel(SelectionModel)}. */ protected AbstractListing() { this(new DataCommunicator<>()); @@ -154,9 +151,6 @@ public abstract class AbstractListing<T> extends AbstractComponent * {@code AbstractListing} with a custom communicator. In the common case * {@link AbstractListing#AbstractListing()} should be used. * <p> - * <strong>Note:</strong> This constructor does not set a selection model - * for the new listing. The invoking constructor must explicitly call - * {@link #setSelectionModel(SelectionModel)}. * * @param dataCommunicator * the data communicator to use, not null @@ -277,7 +271,7 @@ public abstract class AbstractListing<T> extends AbstractComponent /** * Writes listing specific state into the given design. * <p> - * This method is separated from {@link writeDesign(Element, DesignContext)} + * This method is separated from {@link #writeDesign(Element, DesignContext)} * to be overridable in subclasses that need to replace this, but still must * be able to call {@code super.writeDesign(...)}. * @@ -357,7 +351,7 @@ public abstract class AbstractListing<T> extends AbstractComponent /** * Reads the listing specific state from the given design. * <p> - * This method is separated from {@link readDesign(Element, DesignContext)} + * This method is separated from {@link #readDesign(Element, DesignContext)} * to be overridable in subclasses that need to replace this, but still must * be able to call {@code super.readDesign(...)}. * diff --git a/server/src/main/java/com/vaadin/ui/AbstractMultiSelect.java b/server/src/main/java/com/vaadin/ui/AbstractMultiSelect.java index bba3d38fa1..63c2d66d5a 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractMultiSelect.java +++ b/server/src/main/java/com/vaadin/ui/AbstractMultiSelect.java @@ -23,10 +23,9 @@ import java.util.List; import java.util.Objects; import java.util.Optional; import java.util.Set; -import java.util.function.Consumer; -import java.util.function.Predicate; import java.util.stream.Collectors; +import com.vaadin.server.SerializableConsumer; import org.jsoup.nodes.Element; import com.vaadin.data.HasValue; @@ -237,7 +236,7 @@ public abstract class AbstractMultiSelect<T> extends AbstractListing<T> * multiselect component. * * @return the item enabled provider, not {@code null} - * @see #setItemEnabledProvider(Predicate) + * @see #setItemEnabledProvider(SerializablePredicate) */ protected SerializablePredicate<T> getItemEnabledProvider() { return itemEnabledProvider; @@ -462,8 +461,8 @@ public abstract class AbstractMultiSelect<T> extends AbstractListing<T> return item; } - private void updateSelection(Consumer<Set<T>> handler, - boolean userOriginated) { + private void updateSelection(SerializableConsumer<Set<T>> handler, + boolean userOriginated) { LinkedHashSet<T> oldSelection = new LinkedHashSet<>(selection); handler.accept(selection); diff --git a/server/src/main/java/com/vaadin/ui/AbstractSingleSelect.java b/server/src/main/java/com/vaadin/ui/AbstractSingleSelect.java index 538356feaf..521a0b518b 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractSingleSelect.java +++ b/server/src/main/java/com/vaadin/ui/AbstractSingleSelect.java @@ -58,10 +58,6 @@ public abstract class AbstractSingleSelect<T> extends AbstractListing<T> /** * Creates a new {@code AbstractListing} with a default data communicator. * <p> - * <strong>Note:</strong> This constructor does not set a selection model - * for the new listing. The invoking constructor must explicitly call - * {@link #setSelectionModel(SelectionModel)} with an - * {@link AbstractSingleSelect.AbstractSingleSelection} . */ protected AbstractSingleSelect() { init(); @@ -75,10 +71,6 @@ public abstract class AbstractSingleSelect<T> extends AbstractListing<T> * {@code AbstractSingleSelect} with a custom communicator. In the common * case {@link AbstractSingleSelect#AbstractSingleSelect()} should be used. * <p> - * <strong>Note:</strong> This constructor does not set a selection model - * for the new listing. The invoking constructor must explicitly call - * {@link #setSelectionModel(SelectionModel)} with an - * {@link AbstractSingleSelect.AbstractSingleSelection} . * * @param dataCommunicator * the data communicator to use, not null @@ -219,7 +211,7 @@ public abstract class AbstractSingleSelect<T> extends AbstractListing<T> /** * Sets the selection based on a client request. Does nothing if the select - * component is {@linkplain Component#isReadOnly()} or if the selection + * component is {@linkplain #isReadOnly()} or if the selection * would not change. Otherwise updates the selection and fires a selection * change event with {@code isUserOriginated == true}. * diff --git a/server/src/main/java/com/vaadin/ui/ComboBox.java b/server/src/main/java/com/vaadin/ui/ComboBox.java index a15dd6d96c..67a8c79983 100644 --- a/server/src/main/java/com/vaadin/ui/ComboBox.java +++ b/server/src/main/java/com/vaadin/ui/ComboBox.java @@ -311,9 +311,9 @@ public class ComboBox<T> extends AbstractSingleSelect<T> /** * Returns true if the user can enter text into the field to either filter - * the selections or enter a new value if {@link #isNewItemsAllowed()} - * returns true. If text input is disabled, the comboBox will work in the - * same way as a {@link NativeSelect} + * the selections or enter a new value if new item handler is set + * (see {@link #setNewItemHandler(NewItemHandler)}. If text input is disabled, + * the comboBox will work in the same way as a {@link NativeSelect} * * @return true if text input is allowed */ @@ -413,9 +413,7 @@ public class ComboBox<T> extends AbstractSingleSelect<T> * * @param caption * the caption to set, not {@code null} - * @see #getNullSelectionItemId() * @see #isSelected(Object) - * @see #select(Object) */ public void setEmptySelectionCaption(String caption) { Objects.nonNull(caption); diff --git a/server/src/main/java/com/vaadin/ui/Component.java b/server/src/main/java/com/vaadin/ui/Component.java index 7392a29637..09c5f2cc99 100644 --- a/server/src/main/java/com/vaadin/ui/Component.java +++ b/server/src/main/java/com/vaadin/ui/Component.java @@ -47,7 +47,7 @@ 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(Component) setParent()}, you + * 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 @@ -183,8 +183,6 @@ public interface Component extends ClientConnector, Sizeable, Serializable { * style names defined in Vaadin or GWT can not be removed. * </p> * - * * This method will trigger a {@link RepaintRequestEvent}. - * * @param style * the style name or style names to be removed * @see #getStyleName() @@ -261,12 +259,6 @@ public interface Component extends ClientConnector, Sizeable, Serializable { * layout.addComponent(disabled); * </pre> * - * <p> - * This method will trigger a {@link RepaintRequestEvent} for the component - * and, if it is a {@link ComponentContainer}, for all its children - * recursively. - * </p> - * * @param enabled * a boolean value specifying if the component should be enabled * or not @@ -426,11 +418,6 @@ public interface Component extends ClientConnector, Sizeable, Serializable { * display it inside the component. * </p> * - * <p> - * This method will trigger a {@link RepaintRequestEvent}. A - * reimplementation should call the superclass implementation. - * </p> - * * @param caption * the new caption for the component. If the caption is * {@code null}, no caption is shown and it does not normally @@ -498,8 +485,6 @@ public interface Component extends ClientConnector, Sizeable, Serializable { * {@code v-caption} . * </p> * - * This method will trigger a {@link RepaintRequestEvent}. - * * @param icon * the icon of the component. If null, no icon is shown and it * does not normally take any space. diff --git a/server/src/main/java/com/vaadin/ui/ConnectorTracker.java b/server/src/main/java/com/vaadin/ui/ConnectorTracker.java index f66ba4c25d..e317f31fa3 100644 --- a/server/src/main/java/com/vaadin/ui/ConnectorTracker.java +++ b/server/src/main/java/com/vaadin/ui/ConnectorTracker.java @@ -94,7 +94,7 @@ public class ConnectorTracker implements Serializable { * Map to track on which syncId each connector was removed. * * @see #getCurrentSyncId() - * @see #cleanConcurrentlyRemovedConnectorIds(long) + * @see #cleanConcurrentlyRemovedConnectorIds(int) */ private final TreeMap<Integer, Set<String>> syncIdToUnregisteredConnectorIds = new TreeMap<>(); diff --git a/server/src/main/java/com/vaadin/ui/CustomComponent.java b/server/src/main/java/com/vaadin/ui/CustomComponent.java index 67a0b4fff7..73715d1224 100644 --- a/server/src/main/java/com/vaadin/ui/CustomComponent.java +++ b/server/src/main/java/com/vaadin/ui/CustomComponent.java @@ -140,8 +140,7 @@ public class CustomComponent extends AbstractComponent } /** - * Gets the number of contained components. Consistent with the iterator - * returned by {@link #getComponentIterator()}. + * Gets the number of contained components. * * @return the number of contained components (zero or one) */ diff --git a/server/src/main/java/com/vaadin/ui/CustomField.java b/server/src/main/java/com/vaadin/ui/CustomField.java index c813442ffd..c8cfc2a25e 100644 --- a/server/src/main/java/com/vaadin/ui/CustomField.java +++ b/server/src/main/java/com/vaadin/ui/CustomField.java @@ -28,7 +28,7 @@ import com.vaadin.shared.ui.customfield.CustomFieldState; * Customization of both the visual presentation and the logic of the field is * possible. * <p> - * Subclasses must implement {@link #getType()} and {@link #initContent()}. + * Subclasses must implement {@link #initContent()}. * <p> * Most custom fields can simply compose a user interface that calls the methods * {@link #doSetValue(Object)} and {@link #getValue()} when necessary. diff --git a/server/src/main/java/com/vaadin/ui/CustomLayout.java b/server/src/main/java/com/vaadin/ui/CustomLayout.java index d7cbcee962..79146b9cc8 100644 --- a/server/src/main/java/com/vaadin/ui/CustomLayout.java +++ b/server/src/main/java/com/vaadin/ui/CustomLayout.java @@ -88,8 +88,6 @@ public class CustomLayout extends AbstractLayout implements LegacyComponent { * Stream containing template data. Must be using UTF-8 encoding. * To use a String as a template use for instance new * ByteArrayInputStream("<template>".getBytes()). - * @param streamLength - * Length of the templateStream * @throws IOException */ public CustomLayout(InputStream templateStream) throws IOException { diff --git a/server/src/main/java/com/vaadin/ui/DeclarativeItemEnabledProvider.java b/server/src/main/java/com/vaadin/ui/DeclarativeItemEnabledProvider.java index adb2ade00f..123c445fb7 100644 --- a/server/src/main/java/com/vaadin/ui/DeclarativeItemEnabledProvider.java +++ b/server/src/main/java/com/vaadin/ui/DeclarativeItemEnabledProvider.java @@ -42,8 +42,6 @@ class DeclarativeItemEnabledProvider<T> implements SerializablePredicate<T> { * * @param item * a data item - * @param caption - * a caption for the {@code item} */ protected void addDisabled(T item) { disabled.add(item); diff --git a/server/src/main/java/com/vaadin/ui/Embedded.java b/server/src/main/java/com/vaadin/ui/Embedded.java index 786c6d3a86..33f5459081 100644 --- a/server/src/main/java/com/vaadin/ui/Embedded.java +++ b/server/src/main/java/com/vaadin/ui/Embedded.java @@ -536,7 +536,7 @@ public class Embedded extends AbstractComponent implements LegacyComponent { /** * Remove a click listener from the component. The listener should earlier - * have been added using {@link #addListener(ClickListener)}. + * have been added using {@link #addClickListener(ClickListener)}. * * @param listener * The listener to remove diff --git a/server/src/main/java/com/vaadin/ui/Grid.java b/server/src/main/java/com/vaadin/ui/Grid.java index 3752b3044b..9c426567b3 100644 --- a/server/src/main/java/com/vaadin/ui/Grid.java +++ b/server/src/main/java/com/vaadin/ui/Grid.java @@ -1070,9 +1070,7 @@ public class Grid<T> extends AbstractListing<T> implements HasComponents, /** * Sets strings describing back end properties to be used when sorting - * this column. This method is a short hand for - * {@link #setSortBuilder(Function)} that takes an array of strings and - * uses the same sorting direction for all of them. + * this column. * * @param properties * the array of strings describing backend properties @@ -1413,7 +1411,7 @@ public class Grid<T> extends AbstractListing<T> implements HasComponents, * {@link #isHidable() hidable}. * <p> * The default value is <code>null</code>, and in that case the column's - * {@link #getHeaderCaption() header caption} is used. + * {@link #getCaption() header caption} is used. * <p> * <em>NOTE:</em> setting this to empty string might cause the hiding * toggle to not render correctly. @@ -2466,9 +2464,7 @@ public class Grid<T> extends AbstractListing<T> implements HasComponents, } /** - * Returns the footer section of this grid. The default footer contains a - * single row, set as the {@linkplain #setDefaultFooterRow(FooterRow) - * default row}. + * Returns the footer section of this grid. * * @return the footer section */ @@ -2758,7 +2754,7 @@ public class Grid<T> extends AbstractListing<T> implements HasComponents, * @return a registration handle to remove the listener * @throws UnsupportedOperationException * if selection has been disabled with - * {@link SelectionMode.NONE} + * {@link SelectionMode#NONE} */ public Registration addSelectionListener(SelectionListener<T> listener) throws UnsupportedOperationException { diff --git a/server/src/main/java/com/vaadin/ui/GridLayout.java b/server/src/main/java/com/vaadin/ui/GridLayout.java index e4562f81ce..a9607ca96f 100644 --- a/server/src/main/java/com/vaadin/ui/GridLayout.java +++ b/server/src/main/java/com/vaadin/ui/GridLayout.java @@ -1047,7 +1047,7 @@ public class GridLayout extends AbstractLayout * the server and set it to <code>100%</code> in CSS. You must set it to * <code>100%</code> on the server. * - * @see #setWidth(float, int) + * @see #setWidth(float, Unit) * * @param columnIndex * @param ratio @@ -1090,7 +1090,7 @@ public class GridLayout extends AbstractLayout * height on the server and set it to <code>100%</code> in CSS. You must set * it to <code>100%</code> on the server. * - * @see #setHeight(float, int) + * @see #setHeight(float, Unit) * * @param rowIndex * The row index, starting from 0 for the topmost row. diff --git a/server/src/main/java/com/vaadin/ui/HasComponents.java b/server/src/main/java/com/vaadin/ui/HasComponents.java index 3cd1910d83..bb10ca57f6 100644 --- a/server/src/main/java/com/vaadin/ui/HasComponents.java +++ b/server/src/main/java/com/vaadin/ui/HasComponents.java @@ -152,8 +152,6 @@ public interface HasComponents extends Component, Iterable<Component> { /** * Gets the component container. * - * @param the - * component container. */ public HasComponents getContainer() { return (HasComponents) getSource(); @@ -162,8 +160,6 @@ public interface HasComponents extends Component, Iterable<Component> { /** * Gets the attached component. * - * @param the - * attach component. */ public Component getAttachedComponent() { return component; @@ -195,8 +191,6 @@ public interface HasComponents extends Component, Iterable<Component> { /** * Gets the component container. * - * @param the - * component container. */ public HasComponents getContainer() { return (HasComponents) getSource(); diff --git a/server/src/main/java/com/vaadin/ui/ItemCaptionGenerator.java b/server/src/main/java/com/vaadin/ui/ItemCaptionGenerator.java index c608eaf857..d4117c195b 100644 --- a/server/src/main/java/com/vaadin/ui/ItemCaptionGenerator.java +++ b/server/src/main/java/com/vaadin/ui/ItemCaptionGenerator.java @@ -21,7 +21,7 @@ import com.vaadin.server.SerializableFunction; * {@link ItemCaptionGenerator} can be used to customize the string shown to the * user for an item. * - * @see ComboBox#setItemCaptionGenerator(ItemCaptionProvider) + * @see ComboBox#setItemCaptionGenerator(ItemCaptionGenerator) * @param <T> * item type * @since 8.0 diff --git a/server/src/main/java/com/vaadin/ui/Layout.java b/server/src/main/java/com/vaadin/ui/Layout.java index 1a48a4c73b..871e1b2b0b 100644 --- a/server/src/main/java/com/vaadin/ui/Layout.java +++ b/server/src/main/java/com/vaadin/ui/Layout.java @@ -93,7 +93,7 @@ public interface Layout extends ComponentContainer, Serializable { * <strong>NOTE:</strong> This will only affect the space between * components, not the space around all the components in the layout * (i.e. do not confuse this with the cellspacing attribute of a HTML - * Table). Use {@link #setMargin(boolean)} to add space around the + * Table). Use {@link MarginHandler#setMargin(boolean)} to add space around the * layout. * </p> * @@ -140,7 +140,7 @@ public interface Layout extends ComponentContainer, Serializable { * <p> * <strong>NOTE:</strong> This will only affect the space around the * components in the layout, not space between the components in the - * layout. Use {@link #setSpacing(boolean)} to add space between the + * layout. Use {@link SpacingHandler#setSpacing(boolean)} to add space between the * components in the layout. * </p> * diff --git a/server/src/main/java/com/vaadin/ui/ListSelect.java b/server/src/main/java/com/vaadin/ui/ListSelect.java index 1d450d78cf..00679d3e5f 100644 --- a/server/src/main/java/com/vaadin/ui/ListSelect.java +++ b/server/src/main/java/com/vaadin/ui/ListSelect.java @@ -97,7 +97,7 @@ public class ListSelect<T> extends AbstractMultiSelect<T> * select. * <p> * If a height if set (using {@link #setHeight(String)} or - * {@link #setHeight(float, int)}) it overrides the number of rows. Leave + * {@link #setHeight(float, Unit)}) it overrides the number of rows. Leave * the height undefined to use this method. * <p> * Default value is {@link #DEFAULT_ROWS} diff --git a/server/src/main/java/com/vaadin/ui/LoginForm.java b/server/src/main/java/com/vaadin/ui/LoginForm.java index 6d477cf025..2dfd1d0483 100644 --- a/server/src/main/java/com/vaadin/ui/LoginForm.java +++ b/server/src/main/java/com/vaadin/ui/LoginForm.java @@ -39,17 +39,11 @@ import com.vaadin.util.ReflectTools; * passed to that method. The supplied components are specially treated so that * they work with password managers. * <p> - * If you need to change the URL as part of the login procedure, call - * {@link #setLoginMode(LoginMode)} with the argument {@link LoginMode#DEFERRED} - * in your implementation of - * {@link #createContent(com.vaadin.ui.TextField, com.vaadin.ui.PasswordField, com.vaadin.ui.Button) - * createContent}. - * <p> * To customize the fields or to replace them with your own implementations, you * can override {@link #createUsernameField()}, {@link #createPasswordField()} * and {@link #createLoginButton()}. These methods are called automatically and * cannot be called by your code. Captions can be reset by overriding - * {@link #getUsernameFieldCaption()}, {@link #getPasswordFieldCaption()} and + * {@link #getUsernameCaption()}, {@link #getPasswordCaption()} and * {@link #getLoginButtonCaption()}. * <p> * Note that the API of LoginForm changed significantly in Vaadin 7.7. @@ -277,7 +271,7 @@ 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 #getUsernameFieldCaption()}, {@link #getPasswordFieldCaption()} + * {@link #getUsernameCaption()}, {@link #getPasswordCaption()} * and {@link #getLoginButtonCaption()}. You do not have to use the login * button in your layout. * diff --git a/server/src/main/java/com/vaadin/ui/MenuBar.java b/server/src/main/java/com/vaadin/ui/MenuBar.java index 4cb8870c2f..9cf60faddc 100644 --- a/server/src/main/java/com/vaadin/ui/MenuBar.java +++ b/server/src/main/java/com/vaadin/ui/MenuBar.java @@ -468,7 +468,7 @@ public class MenuBar extends AbstractComponent * command associated with it. Icon and command can be null, but a * caption must be given. * - * @param text + * @param caption * The text associated with the command * @param command * The command to be fired @@ -935,7 +935,6 @@ public class MenuBar extends AbstractComponent * The CSS style corresponding to the checked state is "-checked". * </p> * - * @return true if the item is checked, false otherwise * @since 6.6.2 */ public void setChecked(boolean checked) { diff --git a/server/src/main/java/com/vaadin/ui/Notification.java b/server/src/main/java/com/vaadin/ui/Notification.java index 7ee78fb807..9ec031799f 100644 --- a/server/src/main/java/com/vaadin/ui/Notification.java +++ b/server/src/main/java/com/vaadin/ui/Notification.java @@ -402,7 +402,7 @@ public class Notification implements Serializable { * * The caption is rendered as plain text with HTML automatically escaped. * - * @see #Notification(String, int) + * @see Notification(String, int) * @see #show(Page) * * @param caption diff --git a/server/src/main/java/com/vaadin/ui/Panel.java b/server/src/main/java/com/vaadin/ui/Panel.java index 55ca2c643e..ceadf2567d 100644 --- a/server/src/main/java/com/vaadin/ui/Panel.java +++ b/server/src/main/java/com/vaadin/ui/Panel.java @@ -279,7 +279,7 @@ public class Panel extends AbstractSingleComponentContainer /** * Remove a click listener from the Panel. The listener should earlier have - * been added using {@link #addListener(ClickListener)}. + * been added using {@link #addClickListener(ClickListener)}. * * @param listener * The listener to remove diff --git a/server/src/main/java/com/vaadin/ui/PopupView.java b/server/src/main/java/com/vaadin/ui/PopupView.java index 6d047dd723..632f176906 100644 --- a/server/src/main/java/com/vaadin/ui/PopupView.java +++ b/server/src/main/java/com/vaadin/ui/PopupView.java @@ -246,8 +246,7 @@ public class PopupView extends AbstractComponent implements HasComponents { } /** - * Gets the number of contained components. Consistent with the iterator - * returned by {@link #getComponentIterator()}. + * Gets the number of contained components. * * @return the number of contained components (zero or one) */ @@ -349,7 +348,7 @@ public class PopupView extends AbstractComponent implements HasComponents { * @param listener * the listener to remove * @see PopupVisibilityListener - * @see #addListener(PopupVisibilityListener) + * @see #addPopupVisibilityListener(PopupVisibilityListener) * * @deprecated As of 8.0, replaced by {@link Registration#remove()} in the * registration object returned from @@ -402,14 +401,14 @@ public class PopupView extends AbstractComponent implements HasComponents { @FunctionalInterface public interface PopupVisibilityListener extends Serializable { /** - * Pass to {@link PopupView#PopupVisibilityEvent} to start listening for + * Pass to {@link PopupView.PopupVisibilityEvent} to start listening for * popup visibility changes. * * @param event * the event * * @see PopupVisibilityEvent - * @see PopupView#addListener(PopupVisibilityListener) + * @see PopupView#addPopupVisibilityListener(PopupVisibilityListener) */ public void popupVisibilityChange(PopupVisibilityEvent event); } diff --git a/server/src/main/java/com/vaadin/ui/SingleComponentContainer.java b/server/src/main/java/com/vaadin/ui/SingleComponentContainer.java index 712b99f25f..4d603fd087 100644 --- a/server/src/main/java/com/vaadin/ui/SingleComponentContainer.java +++ b/server/src/main/java/com/vaadin/ui/SingleComponentContainer.java @@ -56,7 +56,6 @@ public interface SingleComponentContainer * The content should always be set, either as a constructor parameter or by * calling this method. * - * @return a component (typically a layout) to use as content */ public void setContent(Component content); diff --git a/server/src/main/java/com/vaadin/ui/components/grid/MultiSelectionModelImpl.java b/server/src/main/java/com/vaadin/ui/components/grid/MultiSelectionModelImpl.java index 41158b6f03..89e7374bc6 100644 --- a/server/src/main/java/com/vaadin/ui/components/grid/MultiSelectionModelImpl.java +++ b/server/src/main/java/com/vaadin/ui/components/grid/MultiSelectionModelImpl.java @@ -58,7 +58,7 @@ public class MultiSelectionModelImpl<T> extends AbstractSelectionModel<T> * <p> * Default value is {@link #DEFAULT}, which means that the select all is * only visible if an in-memory data provider is used - * {@link DataSource#isInMemory()}. + * {@link DataProvider#isInMemory()}. */ public enum SelectAllCheckBoxVisibility { /** diff --git a/server/src/main/java/com/vaadin/ui/declarative/DesignContext.java b/server/src/main/java/com/vaadin/ui/declarative/DesignContext.java index c52ccd4655..e3237ada53 100644 --- a/server/src/main/java/com/vaadin/ui/declarative/DesignContext.java +++ b/server/src/main/java/com/vaadin/ui/declarative/DesignContext.java @@ -354,7 +354,7 @@ public class DesignContext implements Serializable { * Returns the default instance for the given class. The instance must not * be modified by the caller. * - * @param abstractComponent + * @param component * @return the default instance for the given class. The return value must * not be modified by the caller */ |