8205454: & is displayed in some Swing docs

Reviewed-by: prr, psadhukhan
This commit is contained in:
Sergey Bylokhov 2018-07-05 21:29:11 +03:00
parent dc7d03e19d
commit 7485f6b5b9
8 changed files with 98 additions and 11 deletions

@ -151,7 +151,7 @@ public class JButton extends AbstractButton implements Accessible {
* @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;
}

@ -235,7 +235,7 @@ public class JCheckBox extends JToggleButton implements Accessible {
* @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;
}

@ -861,7 +861,7 @@ public class JFileChooser extends JComponent implements Accessible {
* @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 @@ public class JFileChooser extends JComponent implements Accessible {
* @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;
}

@ -127,7 +127,7 @@ public class JPanel extends JComponent implements Accessible
}
/**
* 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 @@ public class JPanel extends JComponent implements Accessible
* @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;
}

@ -201,7 +201,7 @@ public class JRadioButton extends JToggleButton implements Accessible {
* @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;
}

@ -377,7 +377,7 @@ public class JSplitPane extends JComponent implements Accessible
* @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 @@ public class JSplitPane extends JComponent implements Accessible
* @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 @@ public class JSplitPane extends JComponent implements Accessible
* <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();

@ -195,7 +195,7 @@ public class JToggleButton extends AbstractButton implements Accessible {
* @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;
}

@ -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());
}
}
}
}
}