<AWT Dev> JDK 9 RFR of 8030845: Fix doclint missing issues in java.awt.event
Phil Race
philip.race at oracle.com
Fri Dec 20 12:58:28 PST 2013
> /** Constant for the substract key. */
I think you can subtract an s here :-)
actually I'd call it "number pad subtract key" like you did
with add and do the same for multiply and divide too.
/** Constant for the decimal key. */
could we call this "decimal point key" ?
There's an extra space in these two :
/** Constant for the META key. */
/** Constant for the QUOTE key. */
/* not clear what this means - listed in Microsoft Windows API */
/** Constant for the FINAL key, listed in the Microsoft Windows API. */
public static final int VK_FINAL = 0x0018;
I can't find this listed in any Windows API.
So I am not sure I want to promote this comment to javadoc.
This and MODECHANGE have the same issue, so this is getting a tad
beyond doclint and into spec.
Some one from AWT who is familiar with keyboard mappings needs to comment.
-phil
On 12/19/2013 10:01 PM, Joe Darcy wrote:
> Hello,
>
> Please review my changes to address
>
> 8030845: Fix doclint missing issues in java.awt.event
>
> in JDK 9. Webrev at
>
> http://cr.openjdk.java.net/~darcy/8030845.0/
>
> patch below.
>
> Thanks,
>
> -Joe
>
> --- old/src/share/classes/java/awt/event/AWTEventListener.java
> 2013-12-19 21:48:44.000000000 -0800
> +++ new/src/share/classes/java/awt/event/AWTEventListener.java
> 2013-12-19 21:48:44.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -56,6 +56,7 @@
>
> /**
> * Invoked when an event is dispatched in the AWT.
> + * @param event the event to be processed
> */
> public void eventDispatched(AWTEvent event);
>
> --- old/src/share/classes/java/awt/event/ActionListener.java
> 2013-12-19 21:48:45.000000000 -0800
> +++ new/src/share/classes/java/awt/event/ActionListener.java
> 2013-12-19 21:48:44.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -46,6 +46,7 @@
>
> /**
> * Invoked when an action occurs.
> + * @param e the event to be processed
> */
> public void actionPerformed(ActionEvent e);
>
> --- old/src/share/classes/java/awt/event/AdjustmentListener.java
> 2013-12-19 21:48:45.000000000 -0800
> +++ new/src/share/classes/java/awt/event/AdjustmentListener.java
> 2013-12-19 21:48:45.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 1999, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -37,6 +37,7 @@
>
> /**
> * Invoked when the value of the adjustable has changed.
> + * @param e the event to be processed
> */
> public void adjustmentValueChanged(AdjustmentEvent e);
>
> --- old/src/share/classes/java/awt/event/ComponentListener.java
> 2013-12-19 21:48:46.000000000 -0800
> +++ new/src/share/classes/java/awt/event/ComponentListener.java
> 2013-12-19 21:48:46.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -54,21 +54,25 @@
> public interface ComponentListener extends EventListener {
> /**
> * Invoked when the component's size changes.
> + * @param e the event to be processed
> */
> public void componentResized(ComponentEvent e);
>
> /**
> * Invoked when the component's position changes.
> + * @param e the event to be processed
> */
> public void componentMoved(ComponentEvent e);
>
> /**
> * Invoked when the component has been made visible.
> + * @param e the event to be processed
> */
> public void componentShown(ComponentEvent e);
>
> /**
> * Invoked when the component has been made invisible.
> + * @param e the event to be processed
> */
> public void componentHidden(ComponentEvent e);
> }
> --- old/src/share/classes/java/awt/event/ContainerListener.java
> 2013-12-19 21:48:46.000000000 -0800
> +++ new/src/share/classes/java/awt/event/ContainerListener.java
> 2013-12-19 21:48:46.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -55,11 +55,13 @@
> public interface ContainerListener extends EventListener {
> /**
> * Invoked when a component has been added to the container.
> + * @param e the event to be processed
> */
> public void componentAdded(ContainerEvent e);
>
> /**
> * Invoked when a component has been removed from the container.
> + * @param e the event to be processed
> */
> public void componentRemoved(ContainerEvent e);
>
> --- old/src/share/classes/java/awt/event/FocusListener.java 2013-12-19
> 21:48:47.000000000 -0800
> +++ new/src/share/classes/java/awt/event/FocusListener.java 2013-12-19
> 21:48:46.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -51,11 +51,13 @@
>
> /**
> * Invoked when a component gains the keyboard focus.
> + * @param e the event to be processed
> */
> public void focusGained(FocusEvent e);
>
> /**
> * Invoked when a component loses the keyboard focus.
> + * @param e the event to be processed
> */
> public void focusLost(FocusEvent e);
> }
> --- old/src/share/classes/java/awt/event/HierarchyBoundsListener.java
> 2013-12-19 21:48:47.000000000 -0800
> +++ new/src/share/classes/java/awt/event/HierarchyBoundsListener.java
> 2013-12-19 21:48:47.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1999, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -52,11 +52,13 @@
> public interface HierarchyBoundsListener extends EventListener {
> /**
> * Called when an ancestor of the source is moved.
> + * @param e the event to be processed
> */
> public void ancestorMoved(HierarchyEvent e);
>
> /**
> * Called when an ancestor of the source is resized.
> + * @param e the event to be processed
> */
> public void ancestorResized(HierarchyEvent e);
> }
> --- old/src/share/classes/java/awt/event/HierarchyListener.java
> 2013-12-19 21:48:48.000000000 -0800
> +++ new/src/share/classes/java/awt/event/HierarchyListener.java
> 2013-12-19 21:48:47.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1999, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -51,6 +51,7 @@
> * Called when the hierarchy has been changed. To discern the actual
> * type of change, call
> <code>HierarchyEvent.getChangeFlags()</code>.
> *
> + * @param e the event to be processed
> * @see HierarchyEvent#getChangeFlags()
> */
> public void hierarchyChanged(HierarchyEvent e);
> --- old/src/share/classes/java/awt/event/InputEvent.java 2013-12-19
> 21:48:48.000000000 -0800
> +++ new/src/share/classes/java/awt/event/InputEvent.java 2013-12-19
> 21:48:48.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2010, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -233,7 +233,8 @@
> * This limit is defined by the relevant number
> * of buttons that may hypothetically exist on the mouse but it
> is greater than the
> * {@link java.awt.MouseInfo#getNumberOfButtons()
> MouseInfo.getNumberOfButtons()}.
> - * <p>
> + *
> + * @return a mask for an existing mouse button.
> * @throws IllegalArgumentException if {@code button} is less
> than zero or greater than the number
> * of button masks reserved for buttons
> * @since 7.0
> @@ -368,6 +369,7 @@
>
> /**
> * Returns whether or not the Shift modifier is down on this event.
> + * @return whether or not the Shift modifier is down on this event
> */
> public boolean isShiftDown() {
> return (modifiers & SHIFT_MASK) != 0;
> @@ -375,6 +377,7 @@
>
> /**
> * Returns whether or not the Control modifier is down on this
> event.
> + * @return whether or not the Control modifier is down on this event
> */
> public boolean isControlDown() {
> return (modifiers & CTRL_MASK) != 0;
> @@ -382,6 +385,7 @@
>
> /**
> * Returns whether or not the Meta modifier is down on this event.
> + * @return whether or not the Meta modifier is down on this event
> */
> public boolean isMetaDown() {
> return (modifiers & META_MASK) != 0;
> @@ -389,6 +393,7 @@
>
> /**
> * Returns whether or not the Alt modifier is down on this event.
> + * @return whether or not the Alt modifier is down on this event
> */
> public boolean isAltDown() {
> return (modifiers & ALT_MASK) != 0;
> @@ -396,6 +401,7 @@
>
> /**
> * Returns whether or not the AltGraph modifier is down on this
> event.
> + * @return whether or not the AltGraph modifier is down on this
> event
> */
> public boolean isAltGraphDown() {
> return (modifiers & ALT_GRAPH_MASK) != 0;
> @@ -404,6 +410,7 @@
> /**
> * Returns the difference in milliseconds between the timestamp
> of when this event occurred and
> * midnight, January 1, 1970 UTC.
> + * @return the difference in milliseconds between the timestamp
> and midnight, January 1, 1970 UTC
> */
> public long getWhen() {
> return when;
> @@ -411,6 +418,7 @@
>
> /**
> * Returns the modifier mask for this event.
> + * @return the modifier mask for this event
> */
> public int getModifiers() {
> return modifiers & (JDK_1_3_MODIFIERS | HIGH_MODIFIERS);
> @@ -451,6 +459,7 @@
> * </PRE>
> * The above code will work even if new modifiers are added.
> *
> + * @return the extended modifier mask for this event
> * @since 1.4
> */
> public int getModifiersEx() {
> @@ -467,6 +476,7 @@
>
> /**
> * Returns whether or not this event has been consumed.
> + * @return whether or not this event has been consumed
> * @see #consume
> */
> public boolean isConsumed() {
> @@ -487,6 +497,9 @@
> * Zero parameter means that no modifiers were passed and will
> * cause the returning an empty string.
> *
> + * @return a String describing the extended modifier keys and
> + * mouse buttons
> + *
> * @param modifiers a modifier mask describing the extended
> * modifier keys and mouse buttons for the event
> * @return a text description of the combination of extended
> --- old/src/share/classes/java/awt/event/InputMethodEvent.java
> 2013-12-19 21:48:48.000000000 -0800
> +++ new/src/share/classes/java/awt/event/InputMethodEvent.java
> 2013-12-19 21:48:48.000000000 -0800
> @@ -277,6 +277,7 @@
>
> /**
> * Gets the number of committed characters in the text.
> + * @return the number of committed characters in the text
> */
> public int getCommittedCharacterCount() {
> return committedCharacterCount;
> --- old/src/share/classes/java/awt/event/InputMethodListener.java
> 2013-12-19 21:48:49.000000000 -0800
> +++ new/src/share/classes/java/awt/event/InputMethodListener.java
> 2013-12-19 21:48:49.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -40,17 +40,17 @@
> * @see java.awt.im.InputMethodRequests
> * @since 1.2
> */
> -
> public interface InputMethodListener extends EventListener {
>
> /**
> * Invoked when the text entered through an input method has
> changed.
> + * @param event the event to be processed
> */
> void inputMethodTextChanged(InputMethodEvent event);
>
> /**
> * Invoked when the caret within composed text has changed.
> + * @param event the event to be processed
> */
> void caretPositionChanged(InputMethodEvent event);
> -
> }
> --- old/src/share/classes/java/awt/event/ItemListener.java 2013-12-19
> 21:48:49.000000000 -0800
> +++ new/src/share/classes/java/awt/event/ItemListener.java 2013-12-19
> 21:48:49.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -50,6 +50,7 @@
> * Invoked when an item has been selected or deselected by the user.
> * The code written for this method performs the operations
> * that need to occur when an item is selected (or deselected).
> + * @param e the event to be processed
> */
> void itemStateChanged(ItemEvent e);
>
> --- old/src/share/classes/java/awt/event/KeyEvent.java 2013-12-19
> 21:48:50.000000000 -0800
> +++ new/src/share/classes/java/awt/event/KeyEvent.java 2013-12-19
> 21:48:50.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2009, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -132,7 +132,7 @@
> * <p>
> * WARNING: Aside from those keys that are defined by the Java language
> * (VK_ENTER, VK_BACK_SPACE, and VK_TAB), do not rely on the values
> of the VK_
> - * constants. Sun reserves the right to change these values as needed
> + * constants. The platform steward reserves the right to change
> these values as needed
> * to accommodate a wider range of keyboards in the future.
> * <p>
> * An unspecified behavior will be caused if the {@code id} parameter
> @@ -194,21 +194,52 @@
>
> /* Virtual key codes. */
>
> + /** Constant for the ENTER virtual key. */
> public static final int VK_ENTER = '\n';
> +
> + /** Constant for the BACK_SPACE virtual key. */
> public static final int VK_BACK_SPACE = '\b';
> +
> + /** Constant for the TAB virtual key. */
> public static final int VK_TAB = '\t';
> +
> + /** Constant for the CANCEL virtual key. */
> public static final int VK_CANCEL = 0x03;
> +
> + /** Constant for the CLEAR virtual key. */
> public static final int VK_CLEAR = 0x0C;
> +
> + /** Constant for the SHIFT virtual key. */
> public static final int VK_SHIFT = 0x10;
> +
> + /** Constant for the CONTROL virtual key. */
> public static final int VK_CONTROL = 0x11;
> +
> + /** Constant for the ALT. virtual key */
> public static final int VK_ALT = 0x12;
> +
> + /** Constant for the PAUSE virtual key. */
> public static final int VK_PAUSE = 0x13;
> +
> + /** Constant for the CAPS_LOCK virtual key. */
> public static final int VK_CAPS_LOCK = 0x14;
> +
> + /** Constant for the ESCAPE virtual key. */
> public static final int VK_ESCAPE = 0x1B;
> +
> + /** Constant for the SPACE virtual key. */
> public static final int VK_SPACE = 0x20;
> +
> + /** Constant for the PAGE_UP virtual key. */
> public static final int VK_PAGE_UP = 0x21;
> +
> + /** Constant for the PAGE_DOWN virtual key. */
> public static final int VK_PAGE_DOWN = 0x22;
> +
> + /** Constant for the END virtual key. */
> public static final int VK_END = 0x23;
> +
> + /** Constant for the HOME virtual key. */
> public static final int VK_HOME = 0x24;
>
> /**
> @@ -257,15 +288,35 @@
> public static final int VK_SLASH = 0x2F;
>
> /** VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 -
> 0x39) */
> +
> + /** Constant for the "0" key. */
> public static final int VK_0 = 0x30;
> +
> + /** Constant for the "1" key. */
> public static final int VK_1 = 0x31;
> +
> + /** Constant for the "2" key. */
> public static final int VK_2 = 0x32;
> +
> + /** Constant for the "3" key. */
> public static final int VK_3 = 0x33;
> +
> + /** Constant for the "4" key. */
> public static final int VK_4 = 0x34;
> +
> + /** Constant for the "5" key. */
> public static final int VK_5 = 0x35;
> +
> + /** Constant for the "6" key. */
> public static final int VK_6 = 0x36;
> +
> + /** Constant for the "7" key. */
> public static final int VK_7 = 0x37;
> +
> + /** Constant for the "8" key. */
> public static final int VK_8 = 0x38;
> +
> + /** Constant for the "9" key. */
> public static final int VK_9 = 0x39;
>
> /**
> @@ -279,31 +330,83 @@
> public static final int VK_EQUALS = 0x3D;
>
> /** VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 -
> 0x5A) */
> +
> + /** Constant for the "A" key. */
> public static final int VK_A = 0x41;
> +
> + /** Constant for the "B" key. */
> public static final int VK_B = 0x42;
> +
> + /** Constant for the "C" key. */
> public static final int VK_C = 0x43;
> +
> + /** Constant for the "D" key. */
> public static final int VK_D = 0x44;
> +
> + /** Constant for the "E" key. */
> public static final int VK_E = 0x45;
> +
> + /** Constant for the "F" key. */
> public static final int VK_F = 0x46;
> +
> + /** Constant for the "G" key. */
> public static final int VK_G = 0x47;
> +
> + /** Constant for the "H" key. */
> public static final int VK_H = 0x48;
> +
> + /** Constant for the "I" key. */
> public static final int VK_I = 0x49;
> +
> + /** Constant for the "J" key. */
> public static final int VK_J = 0x4A;
> +
> + /** Constant for the "K" key. */
> public static final int VK_K = 0x4B;
> +
> + /** Constant for the "L" key. */
> public static final int VK_L = 0x4C;
> +
> + /** Constant for the "M" key. */
> public static final int VK_M = 0x4D;
> +
> + /** Constant for the "N" key. */
> public static final int VK_N = 0x4E;
> +
> + /** Constant for the "O" key. */
> public static final int VK_O = 0x4F;
> +
> + /** Constant for the "P" key. */
> public static final int VK_P = 0x50;
> +
> + /** Constant for the "Q" key. */
> public static final int VK_Q = 0x51;
> +
> + /** Constant for the "R" key. */
> public static final int VK_R = 0x52;
> +
> + /** Constant for the "S" key. */
> public static final int VK_S = 0x53;
> +
> + /** Constant for the "T" key. */
> public static final int VK_T = 0x54;
> +
> + /** Constant for the "U" key. */
> public static final int VK_U = 0x55;
> +
> + /** Constant for the "V" key. */
> public static final int VK_V = 0x56;
> +
> + /** Constant for the "W" key. */
> public static final int VK_W = 0x57;
> +
> + /** Constant for the "X" key. */
> public static final int VK_X = 0x58;
> +
> + /** Constant for the "Y" key. */
> public static final int VK_Y = 0x59;
> +
> + /** Constant for the "Z" key. */
> public static final int VK_Z = 0x5A;
>
> /**
> @@ -321,17 +424,40 @@
> */
> public static final int VK_CLOSE_BRACKET = 0x5D;
>
> + /** Constant for the number pad "0" key. */
> public static final int VK_NUMPAD0 = 0x60;
> +
> + /** Constant for the number pad "1" key. */
> public static final int VK_NUMPAD1 = 0x61;
> +
> + /** Constant for the number pad "2" key. */
> public static final int VK_NUMPAD2 = 0x62;
> +
> + /** Constant for the number pad "3" key. */
> public static final int VK_NUMPAD3 = 0x63;
> +
> + /** Constant for the number pad "4" key. */
> public static final int VK_NUMPAD4 = 0x64;
> +
> + /** Constant for the number pad "5" key. */
> public static final int VK_NUMPAD5 = 0x65;
> +
> + /** Constant for the number pad "6" key. */
> public static final int VK_NUMPAD6 = 0x66;
> +
> + /** Constant for the number pad "7" key. */
> public static final int VK_NUMPAD7 = 0x67;
> +
> + /** Constant for the number pad "8" key. */
> public static final int VK_NUMPAD8 = 0x68;
> +
> + /** Constant for the number pad "9" key. */
> public static final int VK_NUMPAD9 = 0x69;
> +
> + /** Constant for the number pad multiply key. */
> public static final int VK_MULTIPLY = 0x6A;
> +
> + /** Constant for the number pad add key. */
> public static final int VK_ADD = 0x6B;
>
> /**
> @@ -347,11 +473,22 @@
> */
> public static final int VK_SEPARATOR = VK_SEPARATER;
>
> + /** Constant for the substract key. */
> public static final int VK_SUBTRACT = 0x6D;
> +
> + /** Constant for the decimal key. */
> public static final int VK_DECIMAL = 0x6E;
> +
> + /** Constant for the divide key. */
> public static final int VK_DIVIDE = 0x6F;
> +
> + /** Constant for the delete key. */
> public static final int VK_DELETE = 0x7F; /* ASCII DEL */
> +
> + /** Constant for the NUM_LOCK key. */
> public static final int VK_NUM_LOCK = 0x90;
> +
> + /** Constant for the SCROLL_LOCK key. */
> public static final int VK_SCROLL_LOCK = 0x91;
>
> /** Constant for the F1 function key. */
> @@ -463,12 +600,22 @@
> */
> public static final int VK_F24 = 0xF00B;
>
> + /** Constant for the PRINTSCREEN key. */
> public static final int VK_PRINTSCREEN = 0x9A;
> +
> + /** Constant for the INSERT key. */
> public static final int VK_INSERT = 0x9B;
> +
> + /** Constant for the HELP key. */
> public static final int VK_HELP = 0x9C;
> +
> + /** Constant for the META key. */
> public static final int VK_META = 0x9D;
>
> + /** Constant for the BACK_QUOTE key. */
> public static final int VK_BACK_QUOTE = 0xC0;
> +
> + /** Constant for the QUOTE key. */
> public static final int VK_QUOTE = 0xDE;
>
> /**
> @@ -638,6 +785,7 @@
> /* for input method support on Asian Keyboards */
>
> /* not clear what this means - listed in Microsoft Windows API */
> + /** Constant for the FINAL key, listed in the Microsoft Windows
> API. */
> public static final int VK_FINAL = 0x0018;
>
> /** Constant for the Convert function key. */
> @@ -653,14 +801,23 @@
> public static final int VK_ACCEPT = 0x001E;
>
> /* not clear what this means - listed in Microsoft Windows API */
> + /** Constant for the MODECHANGE key, listed in the Microsoft
> Windows API. */
> public static final int VK_MODECHANGE = 0x001F;
>
> /* replaced by VK_KANA_LOCK for Microsoft Windows and Solaris;
> might still be used on other platforms */
> + /**
> + * Constant for the KANA lock key.
> + * @see #VK_KANA_LOCK
> + **/
> public static final int VK_KANA = 0x0015;
>
> /* replaced by VK_INPUT_METHOD_ON_OFF for Microsoft Windows and
> Solaris;
> might still be used for other platforms */
> + /**
> + * Constant for KANJI.
> + * @see #VK_INPUT_METHOD_ON_OFF
> + */
> public static final int VK_KANJI = 0x0019;
>
> /**
> @@ -1085,7 +1242,25 @@
> }
>
> /**
> - * @deprecated as of JDK1.1
> + * @deprecated as of JDK1.1; use {@link #KeyEvent(Component, int,
> long, int, int, char)} instead
> + * @param source The <code>Component</code> that originated
> the event
> + * @param id An integer indicating the type of event.
> + * For information on allowable values, see
> + * the class description for {@link KeyEvent}
> + * @param when A long integer that specifies the time the event
> + * occurred.
> + * Passing negative or zero value
> + * is not recommended
> + * @param modifiers The modifier keys down during event (shift,
> ctrl,
> + * alt, meta).
> + * Passing negative value
> + * is not recommended.
> + * Zero value means that no modifiers were
> passed.
> + * Use either an extended _DOWN_MASK or old
> _MASK modifiers,
> + * however do not mix models in the one event.
> + * The extended modifiers are preferred for using
> + * @param keyCode The integer code for an actual key, or
> VK_UNDEFINED
> + * (for a key-typed event)
> */
> @Deprecated
> public KeyEvent(Component source, int id, long when, int modifiers,
> @@ -1184,6 +1359,7 @@
> * Returns a String describing the keyCode, such as "HOME", "F1"
> or "A".
> * These strings can be localized by changing the awt.properties
> file.
> *
> + * @param keyCode the key whose description is to be returned
> * @return a string containing a text description for a physical
> key,
> * identified by its keyCode
> */
> @@ -1376,6 +1552,7 @@
> * <code>InputEvent.BUTTON3_MASK</code> have the same value,
> * so the string "Meta" is returned for both modifiers.
> *
> + * @param modifiers the modifier mask to be processed
> * @return string a text description of the combination of modifier
> * keys that were held down during the event
> * @see InputEvent#getModifiersExText(int)
> @@ -1612,8 +1789,8 @@
> * Pressing the same key in a regular Russian layout gives
> another code, unique for the
> * letter "Cyrillic I short".
> *
> + * @return an extended key code for the event
> * @since 1.7
> - *
> */
> public int getExtendedKeyCode() {
> return (int)extendedKeyCode;
> @@ -1621,6 +1798,7 @@
> /**
> * Returns an extended key code for a unicode character.
> *
> + * @param c the unicode character to be processed
> * @return for a unicode character with a corresponding {@code
> VK_} constant -- this
> * {@code VK_} constant; for a character appearing on the primary
> * level of a known keyboard layout -- a unique integer.
> @@ -1628,7 +1806,6 @@
> * {@code VK_UNDEFINED} is returned.
> *
> * @since 1.7
> - *
> */
> public static int getExtendedKeyCodeForChar(int c) {
> // Return a keycode (if any) associated with a character.
> --- old/src/share/classes/java/awt/event/KeyListener.java 2013-12-19
> 21:48:50.000000000 -0800
> +++ new/src/share/classes/java/awt/event/KeyListener.java 2013-12-19
> 21:48:50.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -54,6 +54,7 @@
> * Invoked when a key has been typed.
> * See the class description for {@link KeyEvent} for a
> definition of
> * a key typed event.
> + * @param e the event to be processed
> */
> public void keyTyped(KeyEvent e);
>
> @@ -61,6 +62,7 @@
> * Invoked when a key has been pressed.
> * See the class description for {@link KeyEvent} for a
> definition of
> * a key pressed event.
> + * @param e the event to be processed
> */
> public void keyPressed(KeyEvent e);
>
> @@ -68,6 +70,7 @@
> * Invoked when a key has been released.
> * See the class description for {@link KeyEvent} for a
> definition of
> * a key released event.
> + * @param e the event to be processed
> */
> public void keyReleased(KeyEvent e);
> }
> --- old/src/share/classes/java/awt/event/MouseListener.java 2013-12-19
> 21:48:51.000000000 -0800
> +++ new/src/share/classes/java/awt/event/MouseListener.java 2013-12-19
> 21:48:51.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -59,26 +59,31 @@
> /**
> * Invoked when the mouse button has been clicked (pressed
> * and released) on a component.
> + * @param e the event to be processed
> */
> public void mouseClicked(MouseEvent e);
>
> /**
> * Invoked when a mouse button has been pressed on a component.
> + * @param e the event to be processed
> */
> public void mousePressed(MouseEvent e);
>
> /**
> * Invoked when a mouse button has been released on a component.
> + * @param e the event to be processed
> */
> public void mouseReleased(MouseEvent e);
>
> /**
> * Invoked when the mouse enters a component.
> + * @param e the event to be processed
> */
> public void mouseEntered(MouseEvent e);
>
> /**
> * Invoked when the mouse exits a component.
> + * @param e the event to be processed
> */
> public void mouseExited(MouseEvent e);
> }
> --- old/src/share/classes/java/awt/event/MouseMotionListener.java
> 2013-12-19 21:48:51.000000000 -0800
> +++ new/src/share/classes/java/awt/event/MouseMotionListener.java
> 2013-12-19 21:48:51.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -63,12 +63,14 @@
> * Due to platform-dependent Drag&Drop implementations,
> * <code>MOUSE_DRAGGED</code> events may not be delivered during
> a native
> * Drag&Drop operation.
> + * @param e the event to be processed
> */
> public void mouseDragged(MouseEvent e);
>
> /**
> * Invoked when the mouse cursor has been moved onto a component
> * but no buttons have been pushed.
> + * @param e the event to be processed
> */
> public void mouseMoved(MouseEvent e);
>
> --- old/src/share/classes/java/awt/event/MouseWheelListener.java
> 2013-12-19 21:48:52.000000000 -0800
> +++ new/src/share/classes/java/awt/event/MouseWheelListener.java
> 2013-12-19 21:48:52.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 2000, 2003, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -52,6 +52,7 @@
>
> /**
> * Invoked when the mouse wheel is rotated.
> + * @param e the event to be processed
> * @see MouseWheelEvent
> */
> public void mouseWheelMoved(MouseWheelEvent e);
> --- old/src/share/classes/java/awt/event/PaintEvent.java 2013-12-19
> 21:48:52.000000000 -0800
> +++ new/src/share/classes/java/awt/event/PaintEvent.java 2013-12-19
> 21:48:52.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2008, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -108,6 +108,8 @@
> /**
> * Returns the rectangle representing the area which needs to be
> * repainted in response to this event.
> + * @return the rectangle representing the area which needs to be
> + * repainted in response to this event
> */
> public Rectangle getUpdateRect() {
> return updateRect;
> --- old/src/share/classes/java/awt/event/TextListener.java 2013-12-19
> 21:48:53.000000000 -0800
> +++ new/src/share/classes/java/awt/event/TextListener.java 2013-12-19
> 21:48:52.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2008, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -49,6 +49,8 @@
> * Invoked when the value of the text has changed.
> * The code written for this method performs the operations
> * that need to occur when text changes.
> + *
> + * @param e the event to be processed
> */
> public void textValueChanged(TextEvent e);
>
> --- old/src/share/classes/java/awt/event/WindowFocusListener.java
> 2013-12-19 21:48:53.000000000 -0800
> +++ new/src/share/classes/java/awt/event/WindowFocusListener.java
> 2013-12-19 21:48:53.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -57,6 +57,7 @@
> * Invoked when the Window is set to be the focused Window, which
> means
> * that the Window, or one of its subcomponents, will receive
> keyboard
> * events.
> + * @param e the event to be processed
> */
> public void windowGainedFocus(WindowEvent e);
>
> @@ -64,6 +65,7 @@
> * Invoked when the Window is no longer the focused Window, which
> means
> * that keyboard events will no longer be delivered to the Window
> or any of
> * its subcomponents.
> + * @param e the event to be processed
> */
> public void windowLostFocus(WindowEvent e);
> }
> --- old/src/share/classes/java/awt/event/WindowListener.java
> 2013-12-19 21:48:53.000000000 -0800
> +++ new/src/share/classes/java/awt/event/WindowListener.java
> 2013-12-19 21:48:53.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -51,18 +51,21 @@
> public interface WindowListener extends EventListener {
> /**
> * Invoked the first time a window is made visible.
> + * @param e the event to be processed
> */
> public void windowOpened(WindowEvent e);
>
> /**
> * Invoked when the user attempts to close the window
> * from the window's system menu.
> + * @param e the event to be processed
> */
> public void windowClosing(WindowEvent e);
>
> /**
> * Invoked when a window has been closed as the result
> * of calling dispose on the window.
> + * @param e the event to be processed
> */
> public void windowClosed(WindowEvent e);
>
> @@ -71,6 +74,7 @@
> * minimized state. For many platforms, a minimized window
> * is displayed as the icon specified in the window's
> * iconImage property.
> + * @param e the event to be processed
> * @see java.awt.Frame#setIconImage
> */
> public void windowIconified(WindowEvent e);
> @@ -78,6 +82,7 @@
> /**
> * Invoked when a window is changed from a minimized
> * to a normal state.
> + * @param e the event to be processed
> */
> public void windowDeiconified(WindowEvent e);
>
> @@ -88,6 +93,7 @@
> * as a highlighted title bar. The active Window is always either
> the
> * focused Window, or the first Frame or Dialog that is an owner
> of the
> * focused Window.
> + * @param e the event to be processed
> */
> public void windowActivated(WindowEvent e);
>
> @@ -98,6 +104,7 @@
> * highlighted title bar. The active Window is always either the
> focused
> * Window, or the first Frame or Dialog that is an owner of the
> focused
> * Window.
> + * @param e the event to be processed
> */
> public void windowDeactivated(WindowEvent e);
> }
> --- old/src/share/classes/java/awt/event/WindowStateListener.java
> 2013-12-19 21:48:54.000000000 -0800
> +++ new/src/share/classes/java/awt/event/WindowStateListener.java
> 2013-12-19 21:48:54.000000000 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 2001, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights
> reserved.
> * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
> *
> * This code is free software; you can redistribute it and/or modify it
> @@ -50,6 +50,7 @@
> public interface WindowStateListener extends EventListener {
> /**
> * Invoked when window state is changed.
> + * @param e the event to be processed
> */
> public void windowStateChanged(WindowEvent e);
> }
>
More information about the awt-dev
mailing list