diff options
author | Ahmed Ashour <asashour@yahoo.com> | 2017-10-02 09:09:37 +0200 |
---|---|---|
committer | Henri Sara <henri.sara@gmail.com> | 2017-10-02 10:09:37 +0300 |
commit | 763a5cbe8c13ff4a169aae9062c643ad1588cea0 (patch) | |
tree | cf41f4ac4c31925f5ca69d66a3fa6a47fbecfd4f /server/src/main/java/com/vaadin/event | |
parent | adcf2e2e80c6a05ea5e43be15dc7a2576fd2bbb4 (diff) | |
download | vaadin-framework-763a5cbe8c13ff4a169aae9062c643ad1588cea0.tar.gz vaadin-framework-763a5cbe8c13ff4a169aae9062c643ad1588cea0.zip |
First sentence of javadoc should end with a period (#10114)
Also includes minor other javadoc and formatting fixes.
Diffstat (limited to 'server/src/main/java/com/vaadin/event')
7 files changed, 34 insertions, 40 deletions
diff --git a/server/src/main/java/com/vaadin/event/Action.java b/server/src/main/java/com/vaadin/event/Action.java index fceea66a5b..3779ab0756 100644 --- a/server/src/main/java/com/vaadin/event/Action.java +++ b/server/src/main/java/com/vaadin/event/Action.java @@ -178,7 +178,7 @@ public class Action implements Serializable { public interface Container extends Serializable { /** - * Registers a new action handler for this container + * Registers a new action handler for this container. * * @param actionHandler * the new handler to be added. diff --git a/server/src/main/java/com/vaadin/event/ActionManager.java b/server/src/main/java/com/vaadin/event/ActionManager.java index fbc5c8411f..b9e493bce6 100644 --- a/server/src/main/java/com/vaadin/event/ActionManager.java +++ b/server/src/main/java/com/vaadin/event/ActionManager.java @@ -56,7 +56,7 @@ public class ActionManager */ protected HashSet<Handler> actionHandlers = null; - /** Action mapper */ + /** Action mapper. */ protected KeyMapper<Action> actionMapper = null; protected Component viewer; diff --git a/server/src/main/java/com/vaadin/event/FieldEvents.java b/server/src/main/java/com/vaadin/event/FieldEvents.java index c12d683f20..a7a6c65a29 100644 --- a/server/src/main/java/com/vaadin/event/FieldEvents.java +++ b/server/src/main/java/com/vaadin/event/FieldEvents.java @@ -93,7 +93,7 @@ public interface FieldEvents { public static class FocusEvent extends Component.Event { /** - * Identifier for event that can be used in {@link EventRouter} + * Identifier for event that can be used in {@link EventRouter}. */ public static final String EVENT_ID = EventId.FOCUS; @@ -116,7 +116,7 @@ public interface FieldEvents { .findMethod(FocusListener.class, "focus", FocusEvent.class); /** - * Component has been focused + * Component has been focused. * * @param event * Component focus event. @@ -134,7 +134,7 @@ public interface FieldEvents { public static class BlurEvent extends Component.Event { /** - * Identifier for event that can be used in {@link EventRouter} + * Identifier for event that can be used in {@link EventRouter}. */ public static final String EVENT_ID = EventId.BLUR; @@ -157,7 +157,7 @@ public interface FieldEvents { .findMethod(BlurListener.class, "blur", BlurEvent.class); /** - * Component has been blurred + * Component has been blurred. * * @param event * Component blur event. diff --git a/server/src/main/java/com/vaadin/event/LayoutEvents.java b/server/src/main/java/com/vaadin/event/LayoutEvents.java index 6e70687598..bf27cbd036 100644 --- a/server/src/main/java/com/vaadin/event/LayoutEvents.java +++ b/server/src/main/java/com/vaadin/event/LayoutEvents.java @@ -36,7 +36,7 @@ public interface LayoutEvents { LayoutClickEvent.class); /** - * Layout has been clicked + * Layout has been clicked. * * @param event * Component click event. diff --git a/server/src/main/java/com/vaadin/event/ListenerMethod.java b/server/src/main/java/com/vaadin/event/ListenerMethod.java index 07fe664d0d..c631bbec14 100644 --- a/server/src/main/java/com/vaadin/event/ListenerMethod.java +++ b/server/src/main/java/com/vaadin/event/ListenerMethod.java @@ -86,8 +86,7 @@ public class ListenerMethod implements EventListener, Serializable { private int eventArgumentIndex; /* Special serialization to handle method references */ - private void writeObject(ObjectOutputStream out) - throws IOException { + private void writeObject(ObjectOutputStream out) throws IOException { try { out.defaultWriteObject(); String name = method.getName(); @@ -183,10 +182,9 @@ public class ListenerMethod implements EventListener, Serializable { // Checks that the object is of correct type if (!method.getDeclaringClass().isAssignableFrom(target.getClass())) { - throw new IllegalArgumentException( - "The method " + method.getName() - + " cannot be used for the given target: " - + target.getClass().getName()); + throw new IllegalArgumentException("The method " + method.getName() + + " cannot be used for the given target: " + + target.getClass().getName()); } // Checks that the event argument is null @@ -199,10 +197,9 @@ public class ListenerMethod implements EventListener, Serializable { if (eventArgumentIndex >= 0 && !method.getParameterTypes()[eventArgumentIndex] .isAssignableFrom(eventType)) { - throw new IllegalArgumentException( - "The method " + method.getName() - + " does not accept the given eventType: " - + eventType.getName()); + throw new IllegalArgumentException("The method " + method.getName() + + " does not accept the given eventType: " + + eventType.getName()); } this.eventType = eventType; @@ -270,10 +267,9 @@ public class ListenerMethod implements EventListener, Serializable { if (eventArgumentIndex >= 0 && !method.getParameterTypes()[eventArgumentIndex] .isAssignableFrom(eventType)) { - throw new IllegalArgumentException( - "The method " + method.getName() - + " does not accept the given eventType: " - + eventType.getName()); + throw new IllegalArgumentException("The method " + method.getName() + + " does not accept the given eventType: " + + eventType.getName()); } this.eventType = eventType; @@ -314,10 +310,9 @@ public class ListenerMethod implements EventListener, Serializable { // Check that the object is of correct type if (!method.getDeclaringClass().isAssignableFrom(target.getClass())) { - throw new IllegalArgumentException( - "The method " + method.getName() - + " cannot be used for the given target: " - + target.getClass().getName()); + throw new IllegalArgumentException("The method " + method.getName() + + " cannot be used for the given target: " + + target.getClass().getName()); } this.eventType = eventType; @@ -407,10 +402,9 @@ public class ListenerMethod implements EventListener, Serializable { // Checks that the object is of correct type if (!method.getDeclaringClass().isAssignableFrom(target.getClass())) { - throw new IllegalArgumentException( - "The method " + method.getName() - + " cannot be used for the given target: " - + target.getClass().getName()); + throw new IllegalArgumentException("The method " + method.getName() + + " cannot be used for the given target: " + + target.getClass().getName()); } this.eventType = eventType; @@ -523,8 +517,7 @@ public class ListenerMethod implements EventListener, Serializable { } catch (final IllegalAccessException e) { // This should never happen - throw new RuntimeException( - "Internal error - please report", e); + throw new RuntimeException("Internal error - please report", e); } catch (final InvocationTargetException e) { // An exception was thrown by the invocation target. Throw it // forwards. @@ -634,7 +627,7 @@ public class ListenerMethod implements EventListener, Serializable { } /** - * Compares the type of this ListenerMethod to the given type + * Compares the type of this ListenerMethod to the given type. * * @param eventType * The type to compare with @@ -646,7 +639,7 @@ public class ListenerMethod implements EventListener, Serializable { } /** - * Compares the type of this ListenerMethod to the given type + * Compares the type of this ListenerMethod to the given type. * * @param eventType * The type to compare with diff --git a/server/src/main/java/com/vaadin/event/ShortcutAction.java b/server/src/main/java/com/vaadin/event/ShortcutAction.java index e7e5d7cf7b..a100e5d0c6 100644 --- a/server/src/main/java/com/vaadin/event/ShortcutAction.java +++ b/server/src/main/java/com/vaadin/event/ShortcutAction.java @@ -141,15 +141,16 @@ public class ShortcutAction extends Action { * Insert one or more modifier characters before the character to use as * keycode. E.g <code>"&Save"</code> will make a shortcut responding to * ALT-S, <code>"E^xit"</code> will respond to CTRL-X.<br/> - * Multiple modifiers can be used, e.g <code>"&^Delete"</code> will respond - * to CTRL-ALT-D (the order of the modifier characters is not important). + * Multiple modifiers can be used, e.g <code>"&^Delete"</code> will + * respond to CTRL-ALT-D (the order of the modifier characters is not + * important). * </p> * <p> * The modifier characters will be removed from the caption. The modifier * character is be escaped by itself: two consecutive characters are turned * into the original character w/o the special meaning. E.g - * <code>"Save&&&close"</code> will respond to ALT-C, and the caption will - * say "Save&close". + * <code>"Save&&&close"</code> will respond to ALT-C, and the + * caption will say "Save&close". * </p> * * @param shorthandCaption @@ -255,7 +256,7 @@ public class ShortcutAction extends Action { } /** - * Key codes that can be used for shortcuts + * Key codes that can be used for shortcuts. * */ public interface KeyCode extends Serializable { @@ -387,7 +388,7 @@ public class ShortcutAction extends Action { } /** - * Modifier key constants + * Modifier key constants. * */ public interface ModifierKey extends Serializable { diff --git a/server/src/main/java/com/vaadin/event/dd/TargetDetails.java b/server/src/main/java/com/vaadin/event/dd/TargetDetails.java index 710fc5792f..19103d416f 100644 --- a/server/src/main/java/com/vaadin/event/dd/TargetDetails.java +++ b/server/src/main/java/com/vaadin/event/dd/TargetDetails.java @@ -35,7 +35,7 @@ import com.vaadin.ui.dnd.event.DropEvent; public interface TargetDetails extends Serializable { /** - * Gets target data associated with the given string key + * Gets target data associated with the given string key. * * @param key * @return The data associated with the key |