More cleanup

Author: adangel

ReleaseNotes.md

@@ -24,6 +24,9 @@ This is a minor release.
 *   `net.sourceforge.pmd.eclipse.runtime.cmd.BaseVisitor.isUseTaskMarker()`
 *   `net.sourceforge.pmd.eclipse.runtime.cmd.BaseVisitor.setUseTaskMarker(boolean)`
 *   `net.sourceforge.pmd.eclipse.ui.preferences.br.FilterManager`
+*   `net.sourceforge.pmd.eclipse.util.IOUtil`
+*   All classes that couldn't be instantiated because they had a private constructor only
+    are now also `final`.
 
 ### External Contributions
 

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/editors/AbstractEditorFactory.java

@@ -26,6 +26,7 @@ public abstract class AbstractEditorFactory<T> implements EditorFactory<T> {
     // protected static Color overriddenColour;
 
     protected AbstractEditorFactory() {
+        // protected default constructor for subclassing
     }
 
     // private static ColourManager colourManager() {
@@ -50,6 +51,7 @@ protected AbstractEditorFactory() {
      * necessary but must be able to extract the values held by them when the
      * property is created.
      */
+    @Override
     public Control[] createOtherControlsOn(Composite parent, PropertyDescriptor<T> desc, PropertySource source,
             ValueChangeListener listener, SizeChangeListener sizeListener) {
         return new Control[] { newLabel(parent, "Default"), newEditorOn(parent, desc, source, listener, sizeListener) };
@@ -68,18 +70,8 @@ protected T valueFor(PropertySource source, PropertyDescriptor<T> desc) {
         return source.hasDescriptor(desc) ? source.getProperty(desc) : desc.defaultValue();
     }
 
-    /**
-     * Method addLabel.
-     *
-     * @param parent
-     *            Composite
-     * @param desc
-     *            PropertyDescriptor
-     *
-     * @return Label
-     */
+    @Override
     public Label addLabel(Composite parent, PropertyDescriptor<T> desc) {
-
         Label label = new Label(parent, SWT.NONE);
         label.setText(desc.description());
         GridData data = new GridData();
@@ -109,7 +101,7 @@ public Label addLabel(Composite parent, PropertyDescriptor<T> desc) {
     // }
     protected void adjustRendering(PropertySource source, PropertyDescriptor<?> desc, Control control) {
 
-        return; // don't do it...kinda irritating
+        // return; // don't do it...kinda irritating
 
         // if (!(rule instanceof RuleReference)) return;
         //

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/editors/AbstractMultiValueEditorFactory.java

@@ -32,19 +32,19 @@
  * held in the event handlers and passed onto any new handlers created to manage values newly created
  * by the user - hence the monster method calls with umpteen arguments.
  *
- * Concrete subclasses are responsible for instantiating the type-appropriate edit widgets, retrieving
+ * <p>Concrete subclasses are responsible for instantiating the type-appropriate edit widgets, retrieving
  * their values, and updating the rule property. Provided you have widget capable of displaying/editing
  * your value type you can use this class as a base to bring up the appropriate widgets for the
  * individual values.
  *
- * The editor is held in a composite divided into three columns. In the collapsed mode, a text field
+ * <p>The editor is held in a composite divided into three columns. In the collapsed mode, a text field
  * displaying the value collection occupies the first two cells with an expand/collapse button in the
  * last cell. When the user clicks the button the row beneath is given a label, a type-specific edit
  * widget, and a control button for every value in the collection. The last row is empty and serves as
  * a place the user can enter additional values. When the user enters a value and clicks the control
  * button that row becomes read-only and a new empty row is added to the bottom.
  *
- * Note inclusion of the size and value changed callbacks used to let the parent composite resize itself
+ * <p>Note inclusion of the size and value changed callbacks used to let the parent composite resize itself
  * and update the values in the rule listings respectively.
  *
  * @author Brian Remedios
@@ -57,6 +57,7 @@ public abstract class AbstractMultiValueEditorFactory<T> extends AbstractEditorF
 
 
     protected AbstractMultiValueEditorFactory() {
+        // protected default constructor for subclassing
     }
 
 
@@ -75,6 +76,7 @@ protected AbstractMultiValueEditorFactory() {
     protected abstract Control addWidget(Composite parent, T value, PropertyDescriptor<List<T>> desc, PropertySource source);
 
 
+    @Override
     public Control newEditorOn(final Composite parent, final PropertyDescriptor<List<T>> desc,
                                final PropertySource source, final ValueChangeListener changeListener, final SizeChangeListener sizeListener) {
 
@@ -92,7 +94,7 @@ public Control newEditorOn(final Composite parent, final PropertyDescriptor<List
             boolean itemsVisible = false;
             List<Control> items = new ArrayList<Control>();
 
-
+            @Override
             public void handleEvent(Event event) {
                 if (itemsVisible) {
                     hideCollection(items);
@@ -137,7 +139,7 @@ private void delete(Control number, Control widget, Control button, List<Control
         renumberLabelsIn(controlList);
 
         List<T> values = valueFor(source, desc);
-        List<T> newValues = new ArrayList<T>(values.size() - 1);
+        List<T> newValues = new ArrayList<>(values.size() - 1);
         for (T value : values) {
             if (value.equals(deleteValue)) {
                 continue;
@@ -153,7 +155,7 @@ private List<Control> openCollection(final Composite parent, final PropertyDescr
                                          final PropertySource source, final Text textWidget, final ValueChangeListener changeListener,
                                          final SizeChangeListener sizeListener) {
 
-        final List<Control> newControls = new ArrayList<Control>();
+        final List<Control> newControls = new ArrayList<>();
 
         int i;
         List<T> values = valueFor(source, desc);
@@ -167,6 +169,7 @@ private List<Control> openCollection(final Composite parent, final PropertyDescr
             butt.setText("-");  // TODO use icon for consistent width
             final T value = values.get(i);
             butt.addListener(SWT.Selection, new Listener() {  // remove value handler
+                @Override
                 public void handleEvent(Event event) {
                     delete(number, widget, butt, newControls, value, desc, source);
                     fillWidget(textWidget, desc, source); // j
@@ -218,6 +221,7 @@ private void addNewValueRow(final Composite parent, final PropertyDescriptor<Lis
         butt.setText("+");  // TODO use icon for consistent width
         newControls.add(butt);
         Listener addListener = new Listener() {
+            @Override
             public void handleEvent(Event event) {      // add new value handler
                 // add the new value to the property set
                 // set the value in the widget to the cleaned up one, disable it
@@ -255,6 +259,7 @@ private void convertToDelete(final Button button, final T toDeleteValue, final C
         button.setText("-");
         Util.removeListeners(button, SWT.Selection);
         button.addListener(SWT.Selection, new Listener() {
+            @Override
             public void handleEvent(Event event) {
                 delete(number, widget, button, newControls, toDeleteValue, desc, source);
                 fillWidget(parentWidget, desc, source);
@@ -282,7 +287,7 @@ protected List<String> textWidgetValues(Text textWidget) {
         }
 
         String[] valueSet = values.split(DELIMITER);
-        List<String> valueList = new ArrayList<String>(valueSet.length);
+        List<String> valueList = new ArrayList<>(valueSet.length);
 
         for (String value : valueSet) {
             String str = value.trim();

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/editors/AbstractNumericEditorFactory.java

@@ -28,6 +28,7 @@ public abstract class AbstractNumericEditorFactory<T> extends AbstractEditorFact
 
 
     protected AbstractNumericEditorFactory() {
+        // protected default constructor for subclassing
     }
 
 
@@ -67,18 +68,21 @@ protected int digitPrecision() {
 
     private void linkup(final Spinner minWidget, final Spinner valueWidget, final Spinner maxWidget) {
         minWidget.addListener(SWT.Selection, new Listener() {
+            @Override
             public void handleEvent(Event event) {
                 adjustForMin(minWidget, valueWidget, maxWidget);
             }
         });
 
         valueWidget.addListener(SWT.Selection, new Listener() {
+            @Override
             public void handleEvent(Event event) {
                 adjustForValue(minWidget, valueWidget, maxWidget);
             }
         });
 
         maxWidget.addListener(SWT.Selection, new Listener() {
+            @Override
             public void handleEvent(Event event) {
                 adjustForMax(minWidget, valueWidget, maxWidget);
             }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/editors/AbstractRealNumberEditor.java

@@ -21,6 +21,7 @@ public abstract class AbstractRealNumberEditor<T extends Number> extends Abstrac
 
 
     protected AbstractRealNumberEditor() {
+        // protected default constructor for subclassing
     }
 
 

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/editors/BooleanEditorFactory.java

@@ -20,26 +20,29 @@
 /**
  * @author Brian Remedios
  */
-public class BooleanEditorFactory extends AbstractEditorFactory<Boolean> {
+public final class BooleanEditorFactory extends AbstractEditorFactory<Boolean> {
 
     public static final BooleanEditorFactory INSTANCE = new BooleanEditorFactory();
 
 
     private BooleanEditorFactory() { }
 
 
+    @Override
     public PropertyDescriptor<Boolean> createDescriptor(String name, String description, Control[] otherData) {
         return PropertyFactory.booleanProperty(name).desc(description)
-            .defaultValue(otherData == null ? false : valueFrom(otherData[1]))
+            .defaultValue(otherData != null && valueFrom(otherData[1]))
             .build();
     }
 
 
+    @Override
     protected Boolean valueFrom(Control valueControl) {
         return ((Button) valueControl).getSelection();
     }
 
 
+    @Override
     public Control newEditorOn(Composite parent, final PropertyDescriptor<Boolean> desc, final PropertySource source,
                                final ValueChangeListener listener, SizeChangeListener sizeListener) {
 
@@ -50,6 +53,7 @@ public Control newEditorOn(Composite parent, final PropertyDescriptor<Boolean> d
         butt.setSelection(set);
 
         SelectionAdapter sa = new SelectionAdapter() {
+            @Override
             public void widgetSelected(SelectionEvent event) {
                 boolean selected = butt.getSelection();
                 if (selected == valueFor(source, desc)) {

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/editors/CharacterEditorFactory.java

@@ -21,29 +21,31 @@
 /**
  * @author Brian Remedios
  */
-public class CharacterEditorFactory extends AbstractEditorFactory<Character> {
+public final class CharacterEditorFactory extends AbstractEditorFactory<Character> {
 
     public static final CharacterEditorFactory INSTANCE = new CharacterEditorFactory();
 
 
     private CharacterEditorFactory() { }
 
 
+    @Override
     public PropertyDescriptor<Character> createDescriptor(String name, String description, Control[] otherData) {
         return PropertyFactory.charProperty(name).desc(description)
             .defaultValue('a').build();
     }
 
 
+    @Override
     protected Character valueFrom(Control valueControl) {
-
         String value = ((Text) valueControl).getText().trim();
 
-        return (StringUtils.isBlank(value) || value.length() > 1) ? null
-                                                                 : value.charAt(0);
+        return StringUtils.isBlank(value) || value.length() > 1 ? null
+                                                                : value.charAt(0);
     }
 
 
+    @Override
     public Control newEditorOn(Composite parent, final PropertyDescriptor<Character> desc, final PropertySource
         source, final ValueChangeListener listener, SizeChangeListener sizeListener) {
 
@@ -52,6 +54,7 @@ public Control newEditorOn(Composite parent, final PropertyDescriptor<Character>
         fillWidget(text, desc, source);
 
         text.addListener(SWT.FocusOut, new Listener() {
+            @Override
             public void handleEvent(Event event) {
                 Character newValue = charValueIn(text);
                 Character existingValue = valueFor(source, desc);
@@ -69,12 +72,6 @@ public void handleEvent(Event event) {
     }
 
 
-    /**
-     * Method fillWidget.
-     *
-     * @param textWidget Text
-     * @param desc       PropertyDescriptor<?>
-     */
     protected void fillWidget(Text textWidget, PropertyDescriptor<Character> desc, PropertySource source) {
         Character val = valueFor(source, desc);
         textWidget.setText(val == null ? "" : val.toString());

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/editors/DoubleEditorFactory.java

@@ -20,14 +20,15 @@
 /**
  * @author Brian Remedios
  */
-public class DoubleEditorFactory extends AbstractRealNumberEditor<Double> {
+public final class DoubleEditorFactory extends AbstractRealNumberEditor<Double> {
 
     public static final DoubleEditorFactory INSTANCE = new DoubleEditorFactory();
 
 
     private DoubleEditorFactory() { }
 
 
+    @Override
     public PropertyDescriptor<Double> createDescriptor(String name, String description, Control[] otherData) {
         return PropertyFactory.doubleProperty(name).desc(description)
             .defaultValue(defaultIn(otherData).doubleValue())
@@ -36,18 +37,20 @@ public PropertyDescriptor<Double> createDescriptor(String name, String descripti
     }
 
 
+    @Override
     protected Double valueFrom(Control valueControl) {
-
         return ((Spinner) valueControl).getSelection() / SCALE;
     }
 
 
+    @Override
     public Control newEditorOn(Composite parent, final PropertyDescriptor<Double> desc, final PropertySource source,
                                final ValueChangeListener listener, SizeChangeListener sizeListener) {
 
         final Spinner spinner = newSpinnerFor(parent, source, desc);
 
         spinner.addModifyListener(new ModifyListener() {
+            @Override
             public void modifyText(ModifyEvent event) {
                 Double newValue = spinner.getSelection() / SCALE;
                 if (newValue.equals(valueFor(source, desc))) {

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/editors/EnumerationEditorFactory.java

@@ -22,26 +22,28 @@
 /**
  * @author Brian Remedios
  */
-public class EnumerationEditorFactory extends AbstractEditorFactory<Object> {
+public final class EnumerationEditorFactory extends AbstractEditorFactory<Object> {
 
     public static final EnumerationEditorFactory INSTANCE = new EnumerationEditorFactory();
 
 
     private EnumerationEditorFactory() { }
 
 
+    @Override
     protected Object valueFrom(Control valueControl) {
-
-        int index = ((Combo) valueControl).getSelectionIndex();
+        // TODO int index = ((Combo) valueControl).getSelectionIndex();
         return null;    // TODO ???
     }
 
 
+    @Override
     public PropertyDescriptor<Object> createDescriptor(String name, String optionalDescription, Control[] otherData) {
         return PropertyFactory.enumProperty(name, new HashMap<String, Object>()).desc("Value set " + name).build();
     }
 
 
+    @Override
     public Control newEditorOn(Composite parent, final PropertyDescriptor<Object> desc, final PropertySource source,
                                final ValueChangeListener listener, SizeChangeListener sizeListener) {
 
@@ -67,6 +69,7 @@ public Control newEditorOn(Composite parent, final PropertyDescriptor<Object> de
         }
 
         combo.addSelectionListener(new SelectionAdapter() {
+            @Override
             public void widgetSelected(SelectionEvent e) {
                 int selectionIdx = combo.getSelectionIndex();
                 Object[][] choices = (Object[][]) combo.getData();
@@ -86,7 +89,7 @@ public void widgetSelected(SelectionEvent e) {
 
 
     /**
-     * Search through both columns if necessary
+     * Search through both columns if necessary.
      */
     public static int indexOf(Object item, Object[][] items) {
         int index = indexOf(item, items, 0);
@@ -104,8 +107,7 @@ public static int indexOf(Object item, Object[][] items, int testColumnIndex) {
     }
 
     public static <T> Object[][] choices(PropertyDescriptor<T> prop) {
-        Object[][] res = new Object[0][2];
         // TODO: prop.mapping() would be needed to get the valid choices....
-        return res;
+        return new Object[0][2];
     }
 }