changeset 50993:3924d4cf8b41

8205454: & is displayed in some Swing docs Reviewed-by: prr, psadhukhan
author serb
date Thu, 05 Jul 2018 21:29:11 +0300
parents faf1cd52a5b7
children 09776f847bf4
files src/java.desktop/share/classes/javax/swing/JButton.java src/java.desktop/share/classes/javax/swing/JCheckBox.java src/java.desktop/share/classes/javax/swing/JFileChooser.java src/java.desktop/share/classes/javax/swing/JPanel.java src/java.desktop/share/classes/javax/swing/JRadioButton.java src/java.desktop/share/classes/javax/swing/JSplitPane.java src/java.desktop/share/classes/javax/swing/JToggleButton.java test/jdk/java/beans/Beans/TypoInBeanDescription.java
diffstat 8 files changed, 98 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/src/java.desktop/share/classes/javax/swing/JButton.java	Tue Jun 12 13:00:50 2018 +0530
+++ b/src/java.desktop/share/classes/javax/swing/JButton.java	Thu Jul 05 21:29:11 2018 +0300
@@ -151,7 +151,7 @@
      * @see UIDefaults#getUI
      */
     @BeanProperty(bound = false, expert = true, description
-            = "A string that specifies the name of the L&F class.")
+            = "A string that specifies the name of the L&F class.")
     public String getUIClassID() {
         return uiClassID;
     }
--- a/src/java.desktop/share/classes/javax/swing/JCheckBox.java	Tue Jun 12 13:00:50 2018 +0530
+++ b/src/java.desktop/share/classes/javax/swing/JCheckBox.java	Thu Jul 05 21:29:11 2018 +0300
@@ -235,7 +235,7 @@
      * @see UIDefaults#getUI
      */
     @BeanProperty(bound = false, expert = true, description
-            = "A string that specifies the name of the L&F class")
+            = "A string that specifies the name of the L&F class")
     public String getUIClassID() {
         return uiClassID;
     }
--- a/src/java.desktop/share/classes/javax/swing/JFileChooser.java	Tue Jun 12 13:00:50 2018 +0530
+++ b/src/java.desktop/share/classes/javax/swing/JFileChooser.java	Thu Jul 05 21:29:11 2018 +0300
@@ -861,7 +861,7 @@
      * @since 1.3
      */
     @BeanProperty(preferred = true, description
-            = "Sets whether the approve & cancel buttons are shown.")
+            = "Sets whether the approve & cancel buttons are shown.")
     public void setControlButtonsAreShown(boolean b) {
         if(controlsShown == b) {
             return;
@@ -1838,7 +1838,7 @@
      * @see UIDefaults#getUI
      */
     @BeanProperty(bound = false, expert = true, description
-            = "A string that specifies the name of the L&F class.")
+            = "A string that specifies the name of the L&F class.")
     public String getUIClassID() {
         return uiClassID;
     }
--- a/src/java.desktop/share/classes/javax/swing/JPanel.java	Tue Jun 12 13:00:50 2018 +0530
+++ b/src/java.desktop/share/classes/javax/swing/JPanel.java	Thu Jul 05 21:29:11 2018 +0300
@@ -127,7 +127,7 @@
     }
 
     /**
-     * Returns the look and feel (L&F) object that renders this component.
+     * Returns the look and feel (L&F) object that renders this component.
      *
      * @return the PanelUI object that renders this component
      * @since 1.4
@@ -159,7 +159,7 @@
      * @see UIDefaults#getUI
      */
     @BeanProperty(bound = false, expert = true, description
-            = "A string that specifies the name of the L&F class.")
+            = "A string that specifies the name of the L&F class.")
     public String getUIClassID() {
         return uiClassID;
     }
--- a/src/java.desktop/share/classes/javax/swing/JRadioButton.java	Tue Jun 12 13:00:50 2018 +0530
+++ b/src/java.desktop/share/classes/javax/swing/JRadioButton.java	Thu Jul 05 21:29:11 2018 +0300
@@ -201,7 +201,7 @@
      * @see UIDefaults#getUI
      */
     @BeanProperty(bound = false, expert = true, description
-            = "A string that specifies the name of the L&F class.")
+            = "A string that specifies the name of the L&F class.")
     public String getUIClassID() {
         return uiClassID;
     }
--- a/src/java.desktop/share/classes/javax/swing/JSplitPane.java	Tue Jun 12 13:00:50 2018 +0530
+++ b/src/java.desktop/share/classes/javax/swing/JSplitPane.java	Thu Jul 05 21:29:11 2018 +0300
@@ -377,7 +377,7 @@
      * @return the <code>SplitPaneUI</code> object that renders this component
      */
     @BeanProperty(bound = false, expert = true, description
-            = "The L&amp;F object that renders this component.")
+            = "The L&F object that renders this component.")
     public SplitPaneUI getUI() {
         return (SplitPaneUI)ui;
     }
@@ -404,7 +404,7 @@
      * @see UIDefaults#getUI
      */
     @BeanProperty(bound = false, expert = true, description
-            = "A string that specifies the name of the L&amp;F class.")
+            = "A string that specifies the name of the L&F class.")
     public String getUIClassID() {
         return uiClassID;
     }
@@ -824,7 +824,7 @@
      *          <code>null</code>
      */
     @BeanProperty(bound = false, description
-            = "The minimum location of the divider from the L&amp;F.")
+            = "The minimum location of the divider from the L&F.")
     public int getMinimumDividerLocation() {
         SplitPaneUI         ui = getUI();
 
--- a/src/java.desktop/share/classes/javax/swing/JToggleButton.java	Tue Jun 12 13:00:50 2018 +0530
+++ b/src/java.desktop/share/classes/javax/swing/JToggleButton.java	Thu Jul 05 21:29:11 2018 +0300
@@ -195,7 +195,7 @@
      * @see UIDefaults#getUI
      */
     @BeanProperty(bound = false, description
-            = "A string that specifies the name of the L&amp;F class")
+            = "A string that specifies the name of the L&F class")
     public String getUIClassID() {
         return uiClassID;
     }
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/jdk/java/beans/Beans/TypoInBeanDescription.java	Thu Jul 05 21:29:11 2018 +0300
@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2018, 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+import java.beans.BeanInfo;
+import java.beans.IntrospectionException;
+import java.beans.Introspector;
+import java.io.IOException;
+import java.net.URI;
+import java.nio.file.FileSystem;
+import java.nio.file.FileSystems;
+import java.nio.file.FileVisitResult;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.SimpleFileVisitor;
+import java.nio.file.attribute.BasicFileAttributes;
+
+/**
+ * @test
+ * @bug 8205454
+ */
+public final class TypoInBeanDescription {
+
+    private static final String[] typos = {"&amp;", "&lt;", "&gt;", "&quot;"};
+
+    public static void main(final String[] args) throws IOException {
+        FileSystem fs = FileSystems.getFileSystem(URI.create("jrt:/"));
+        Files.walkFileTree(fs.getPath("/modules/java.desktop"), new SimpleFileVisitor<>() {
+            @Override
+            public FileVisitResult visitFile(Path file,
+                                             BasicFileAttributes attrs) {
+                file = file.subpath(2, file.getNameCount());
+                String name = file.toString();
+                if (name.endsWith(".class")) {
+                    name = name.substring(0, name.indexOf(".")).replace('/', '.');
+
+                    final Class<?> type;
+                    try {
+                        type = Class.forName(name);
+                    } catch (Throwable e) {
+                        return FileVisitResult.CONTINUE;
+                    }
+                    final BeanInfo beanInfo;
+                    try {
+                        beanInfo = Introspector.getBeanInfo(type);
+                    } catch (IntrospectionException e) {
+                        return FileVisitResult.CONTINUE;
+                    }
+                    test(beanInfo);
+                }
+                return FileVisitResult.CONTINUE;
+            }
+        });
+    }
+
+    private static void test(final BeanInfo beanInfo) {
+        for (var pd : beanInfo.getPropertyDescriptors()) {
+            String d = pd.getShortDescription();
+            String n = pd.getName();
+            String dn = pd.getDisplayName();
+            for (String typo : typos) {
+                if (d.contains(typo) || n.contains(typo) || dn.contains(typo)) {
+                    throw new RuntimeException("Wrong name: " + beanInfo.getBeanDescriptor());
+                }
+            }
+        }
+    }
+}