diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md index 5687105f4a..67fbe30ae2 100644 --- a/docs/pages/release_notes.md +++ b/docs/pages/release_notes.md @@ -427,6 +427,35 @@ a warning will now be produced suggesting users to adopt it for better performan * The constructor of `net.sourceforge.pmd.RuleSetFactory`, which took a `ClassLoader` is deprecated. Please use the alternative constructor with the `net.sourceforge.pmd.util.ResourceLoader` instead. +* The following GUI related classes have been deprecated and will be removed in PMD 7.0.0. + The tool "bgastviewer", that could be started via the script `bgastviewer.bat` or `run.sh bgastviewer` is + deprecated, too, and will be removed in PMD 7.0.0. + Both the "old designer" and "bgastviewer" are replaced by the [New Rule Designer](#new-rule-designer). + * `net.sourceforge.pmd.util.designer.CodeEditorTextPane` + * `net.sourceforge.pmd.util.designer.CreateXMLRulePanel` + * `net.sourceforge.pmd.util.designer.Designer` + * `net.sourceforge.pmd.util.designer.DFAPanel` + * `net.sourceforge.pmd.util.designer.LineGetter` + * `net.sourceforge.pmd.util.viewer.Viewer` + * `net.sourceforge.pmd.util.viewer.gui.ActionCommands` + * `net.sourceforge.pmd.util.viewer.gui.ASTPanel` + * `net.sourceforge.pmd.util.viewer.gui.EvaluationResultsPanel` + * `net.sourceforge.pmd.util.viewer.gui.MainFrame` + * `net.sourceforge.pmd.util.viewer.gui.ParseExceptionHandler` + * `net.sourceforge.pmd.util.viewer.gui.SourceCodePanel` + * `net.sourceforge.pmd.util.viewer.gui.XPathPanel` + * `net.sourceforge.pmd.util.viewer.gui.menu.ASTNodePopupMenu` + * `net.sourceforge.pmd.util.viewer.gui.menu.AttributesSubMenu` + * `net.sourceforge.pmd.util.viewer.gui.menu.SimpleNodeSubMenu` + * `net.sourceforge.pmd.util.viewer.gui.menu.XPathFragmentAddingItem` + * `net.sourceforge.pmd.util.viewer.model.ASTModel` + * `net.sourceforge.pmd.util.viewer.model.AttributeToolkit` + * `net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter` + * `net.sourceforge.pmd.util.viewer.model.ViewerModel` + * `net.sourceforge.pmd.util.viewer.model.ViewerModelEvent` + * `net.sourceforge.pmd.util.viewer.model.ViewerModelListener` + * `net.sourceforge.pmd.util.viewer.util.NLS` + ### External Contributions * [#287](https://github.com/pmd/pmd/pull/287): \[apex] Make Rule suppression work - [Robert Sösemann](https://github.com/up2go-rsoesemann) diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CodeEditorTextPane.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CodeEditorTextPane.java index 25d3c70d23..ac13ce6ef5 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CodeEditorTextPane.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CodeEditorTextPane.java @@ -8,7 +8,7 @@ import javax.swing.JTextPane; import net.sourceforge.pmd.lang.ast.Node; -@Deprecated +@Deprecated // to be removed with PMD 7.0.0 public class CodeEditorTextPane extends JTextPane implements LineGetter { private String[] getLines() { diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CreateXMLRulePanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CreateXMLRulePanel.java index 629103dba2..3c2c67edf7 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CreateXMLRulePanel.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CreateXMLRulePanel.java @@ -24,7 +24,7 @@ import net.sourceforge.pmd.PMD; * This class is responsible for creating the contentpanel for the Create Rule * XML Frame. */ -@Deprecated +@Deprecated // to be removed with PMD 7.0.0 public class CreateXMLRulePanel extends JPanel implements ActionListener { private JTextField rulenameField = new JTextField(30); diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/DFAPanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/DFAPanel.java index 840a02ecfa..a6a84fccc7 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/DFAPanel.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/DFAPanel.java @@ -29,7 +29,7 @@ import net.sourceforge.pmd.lang.dfa.DataFlowNode; import net.sourceforge.pmd.lang.dfa.VariableAccess; import net.sourceforge.pmd.util.StringUtil; -@Deprecated +@Deprecated // to be removed with PMD 7.0.0 public class DFAPanel extends JComponent implements ListSelectionListener { public static class DFACanvas extends JPanel { diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/Designer.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/Designer.java index e5be408d36..e7391d90ef 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/Designer.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/Designer.java @@ -124,7 +124,7 @@ import net.sourceforge.pmd.lang.symboltable.Scope; import net.sourceforge.pmd.lang.symboltable.ScopedNode; import net.sourceforge.pmd.lang.xpath.Initializer; -@Deprecated +@Deprecated // to be removed with PMD 7.0.0 public class Designer implements ClipboardOwner { private boolean exitOnClose = true; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/LineGetter.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/LineGetter.java index de1679ff6e..4e657341fc 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/LineGetter.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/LineGetter.java @@ -4,7 +4,7 @@ package net.sourceforge.pmd.util.designer; -@Deprecated +@Deprecated // to be removed with PMD 7.0.0 public interface LineGetter { String getLine(int number); } diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/Viewer.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/Viewer.java index 2ae10bbaa4..0b3bf0a531 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/Viewer.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/Viewer.java @@ -13,6 +13,7 @@ import net.sourceforge.pmd.util.viewer.gui.MainFrame; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ +@Deprecated // to be removed with PMD 7.0.0 public class Viewer { private Viewer() { } diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ASTPanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ASTPanel.java index 778b4c2558..b0f7ae7cc4 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ASTPanel.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ASTPanel.java @@ -35,7 +35,7 @@ import net.sourceforge.pmd.util.viewer.util.NLS; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ - +@Deprecated // to be removed with PMD 7.0.0 public class ASTPanel extends JPanel implements ViewerModelListener, TreeSelectionListener { private ViewerModel model; private JTree tree; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ActionCommands.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ActionCommands.java index 17d67665c2..6f9f13dfc4 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ActionCommands.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ActionCommands.java @@ -9,7 +9,7 @@ package net.sourceforge.pmd.util.viewer.gui; * * @author Boris Gruschko ( boris at gruschko.org ) */ - +@Deprecated // to be removed with PMD 7.0.0 public final class ActionCommands { public static final String COMPILE_ACTION = "Compile"; public static final String EVALUATE_ACTION = "Evaluate"; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/EvaluationResultsPanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/EvaluationResultsPanel.java index de6dd42be0..1a674db28e 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/EvaluationResultsPanel.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/EvaluationResultsPanel.java @@ -25,6 +25,7 @@ import net.sourceforge.pmd.util.viewer.model.ViewerModelListener; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ +@Deprecated // to be removed with PMD 7.0.0 public class EvaluationResultsPanel extends JPanel implements ViewerModelListener { private ViewerModel model; private JList list; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/MainFrame.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/MainFrame.java index f6ef38715b..37951cdd3b 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/MainFrame.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/MainFrame.java @@ -35,7 +35,7 @@ import net.sourceforge.pmd.util.viewer.util.NLS; * * @author Boris Gruschko ( boris at gruschko.org ) */ - +@Deprecated // to be removed with PMD 7.0.0 public class MainFrame extends JFrame implements ActionListener, ViewerModelListener { private ViewerModel model; private SourceCodePanel sourcePanel; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ParseExceptionHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ParseExceptionHandler.java index c78b268c45..d671111b33 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ParseExceptionHandler.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ParseExceptionHandler.java @@ -25,7 +25,7 @@ import net.sourceforge.pmd.util.viewer.util.NLS; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ - +@Deprecated // to be removed with PMD 7.0.0 public class ParseExceptionHandler extends JDialog implements ActionListener { private Exception exc; private JButton okBtn; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/SourceCodePanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/SourceCodePanel.java index 35f6126627..6625136d86 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/SourceCodePanel.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/SourceCodePanel.java @@ -27,7 +27,7 @@ import net.sourceforge.pmd.util.viewer.util.NLS; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ - +@Deprecated // to be removed with PMD 7.0.0 public class SourceCodePanel extends JPanel implements ViewerModelListener { private ViewerModel model; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/XPathPanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/XPathPanel.java index 3cf6b421b4..d342d2921d 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/XPathPanel.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/XPathPanel.java @@ -23,7 +23,7 @@ import net.sourceforge.pmd.util.viewer.util.NLS; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ - +@Deprecated // to be removed with PMD 7.0.0 public class XPathPanel extends JTabbedPane implements ViewerModelListener { private ViewerModel model; private JTextArea xPathArea; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/ASTNodePopupMenu.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/ASTNodePopupMenu.java index 0b124b53b6..bc4c265552 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/ASTNodePopupMenu.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/ASTNodePopupMenu.java @@ -15,6 +15,7 @@ import net.sourceforge.pmd.util.viewer.model.ViewerModel; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ +@Deprecated // to be removed with PMD 7.0.0 public class ASTNodePopupMenu extends JPopupMenu { private ViewerModel model; private Node node; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/AttributesSubMenu.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/AttributesSubMenu.java index 54dd1862b1..7b797e2bbd 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/AttributesSubMenu.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/AttributesSubMenu.java @@ -21,6 +21,7 @@ import net.sourceforge.pmd.util.viewer.util.NLS; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ +@Deprecated // to be removed with PMD 7.0.0 public class AttributesSubMenu extends JMenu { private ViewerModel model; private Node node; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/SimpleNodeSubMenu.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/SimpleNodeSubMenu.java index d3323aec76..5384334def 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/SimpleNodeSubMenu.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/SimpleNodeSubMenu.java @@ -18,6 +18,7 @@ import net.sourceforge.pmd.util.viewer.util.NLS; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ +@Deprecated // to be removed with PMD 7.0.0 public class SimpleNodeSubMenu extends JMenu { private ViewerModel model; private Node node; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/XPathFragmentAddingItem.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/XPathFragmentAddingItem.java index aac92d912f..b028063c6f 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/XPathFragmentAddingItem.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/XPathFragmentAddingItem.java @@ -17,6 +17,7 @@ import net.sourceforge.pmd.util.viewer.model.ViewerModel; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ +@Deprecated // to be removed with PMD 7.0.0 public class XPathFragmentAddingItem extends JMenuItem implements ActionListener { private ViewerModel model; private String fragment; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ASTModel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ASTModel.java index de0f82f7de..f0b1f48b82 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ASTModel.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ASTModel.java @@ -20,7 +20,7 @@ import net.sourceforge.pmd.lang.ast.Node; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ - +@Deprecated // to be removed with PMD 7.0.0 public class ASTModel implements TreeModel { private Node root; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/AttributeToolkit.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/AttributeToolkit.java index cc03f0949f..74760679dd 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/AttributeToolkit.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/AttributeToolkit.java @@ -12,7 +12,7 @@ import net.sourceforge.pmd.lang.ast.xpath.Attribute; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ - +@Deprecated // to be removed with PMD 7.0.0 public class AttributeToolkit { private AttributeToolkit() { } diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/SimpleNodeTreeNodeAdapter.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/SimpleNodeTreeNodeAdapter.java index 6190948ba0..c52609efaf 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/SimpleNodeTreeNodeAdapter.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/SimpleNodeTreeNodeAdapter.java @@ -19,7 +19,7 @@ import net.sourceforge.pmd.lang.ast.Node; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ - +@Deprecated // to be removed with PMD 7.0.0 public class SimpleNodeTreeNodeAdapter implements TreeNode { private Node node; diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModel.java index 93ef74f1f7..4369b7d8ae 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModel.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModel.java @@ -20,6 +20,7 @@ import net.sourceforge.pmd.lang.ast.Node; import net.sourceforge.pmd.lang.ast.ParseException; import net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator; +@Deprecated // to be removed with PMD 7.0.0 public class ViewerModel { private static final Logger LOGGER = Logger.getLogger(ViewerModel.class.getName()); diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelEvent.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelEvent.java index 0c36a588e1..ab8f812216 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelEvent.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelEvent.java @@ -11,6 +11,7 @@ package net.sourceforge.pmd.util.viewer.model; * * @author Boris Gruschko ( boris at gruschko.org ) */ +@Deprecated // to be removed with PMD 7.0.0 public class ViewerModelEvent { /** * reason in the case of code recompilation diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelListener.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelListener.java index e79e2a5115..a38a3826ab 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelListener.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelListener.java @@ -10,6 +10,7 @@ package net.sourceforge.pmd.util.viewer.model; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ +@Deprecated // to be removed with PMD 7.0.0 public interface ViewerModelListener { void viewerModelChanged(ViewerModelEvent e); } diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/util/NLS.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/util/NLS.java index ed703f9899..807832b40b 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/util/NLS.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/util/NLS.java @@ -12,6 +12,7 @@ import java.util.ResourceBundle; * @author Boris Gruschko ( boris at gruschko.org ) * @version $Id$ */ +@Deprecated // to be removed with PMD 7.0.0 public class NLS { private static final ResourceBundle BUNDLE;