[Japi-cvs] SF.net SVN: japi: [562] libs/swing-misc/trunk/src/net/sf/japi/swing/misc

[<chr...@us...>]

Revision: 562
          http://japi.svn.sourceforge.net/japi/?rev=562&view=rev
Author:   christianhujer
Date:     2007-07-30 13:30:49 -0700 (Mon, 30 Jul 2007)

Log Message:
-----------
Fixed javadoc and inspections issues.

Modified Paths:
--------------
    libs/swing-misc/trunk/src/net/sf/japi/swing/misc/CollectionsListModel.java
    libs/swing-misc/trunk/src/net/sf/japi/swing/misc/ConsoleProgress.java
    libs/swing-misc/trunk/src/net/sf/japi/swing/misc/JFileChooserButton.java
    libs/swing-misc/trunk/src/net/sf/japi/swing/misc/JFileField.java
    libs/swing-misc/trunk/src/net/sf/japi/swing/misc/ProgressDisplay.java

Modified: libs/swing-misc/trunk/src/net/sf/japi/swing/misc/CollectionsListModel.java
===================================================================
--- libs/swing-misc/trunk/src/net/sf/japi/swing/misc/CollectionsListModel.java	2007-07-30 20:19:09 UTC (rev 561)
+++ libs/swing-misc/trunk/src/net/sf/japi/swing/misc/CollectionsListModel.java	2007-07-30 20:30:49 UTC (rev 562)
@@ -32,13 +32,19 @@
  */
 public class CollectionsListModel<E> extends AbstractListModel implements List<E> {
 
-    /** The list to delegate to. */
+    /** The list to delegate to.
+     * @serial include
+     */
     private final List<E> list;
 
     /**
      * Creates a new CollectionsListModel.
-     * @param list List to delegate to
+     * @param list List to delegate to.
+     * @note This ListModel does not hold a copy of the supplied list but references it.
+     *       All changes to the list model will be reflected in the supplied list and vice versa.
+     * @note In order for events to be fired, this ListModel must be used for list modifications, not the underlying list.
      */
+    @SuppressWarnings({"AssignmentToCollectionOrArrayFieldFromParameter"})
     public CollectionsListModel(final List<E> list) {
         this.list = list;
     }
@@ -148,12 +154,12 @@
     }
 
     /** {@inheritDoc} */
-    public boolean equals(final Object o) {
+    @Override public boolean equals(final Object o) {
         return list.equals(o);
     }
 
     /** {@inheritDoc} */
-    public int hashCode() {
+    @Override public int hashCode() {
         return list.hashCode();
     }
 

Modified: libs/swing-misc/trunk/src/net/sf/japi/swing/misc/ConsoleProgress.java
===================================================================
--- libs/swing-misc/trunk/src/net/sf/japi/swing/misc/ConsoleProgress.java	2007-07-30 20:19:09 UTC (rev 561)
+++ libs/swing-misc/trunk/src/net/sf/japi/swing/misc/ConsoleProgress.java	2007-07-30 20:30:49 UTC (rev 562)
@@ -2,8 +2,8 @@
 
 import java.awt.Component;
 import java.io.Closeable;
+import java.io.Flushable;
 import java.io.IOException;
-import java.io.Flushable;
 import org.jetbrains.annotations.Nullable;
 
 /**
@@ -106,6 +106,7 @@
             return;
         }
         try {
+            //noinspection MagicNumber
             final int prog = value * 100 / max;
             out.append(String.format("%3d", prog));
             flush();

Modified: libs/swing-misc/trunk/src/net/sf/japi/swing/misc/JFileChooserButton.java
===================================================================
--- libs/swing-misc/trunk/src/net/sf/japi/swing/misc/JFileChooserButton.java	2007-07-30 20:19:09 UTC (rev 561)
+++ libs/swing-misc/trunk/src/net/sf/japi/swing/misc/JFileChooserButton.java	2007-07-30 20:30:49 UTC (rev 562)
@@ -19,13 +19,14 @@
 
 package net.sf.japi.swing.misc;
 
+import java.awt.Insets;
+import java.io.File;
+import java.io.IOException;
 import javax.swing.JButton;
+import javax.swing.JFileChooser;
 import javax.swing.JTextField;
-import javax.swing.JFileChooser;
 import net.sf.japi.swing.ActionFactory;
-import java.io.File;
-import java.io.IOException;
-import java.awt.Insets;
+import net.sf.japi.swing.ActionMethod;
 
 /** JButton for choosing a file from hd.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
@@ -135,9 +136,8 @@
         return chooser;
     }
 
-    /** Action method.
-     * @used
-     */
+    /** Action method. */
+    @ActionMethod
     public void optionsChooseFile() {
         final String oldFilename = textField.getText();
         final File oldFile = new File(base, oldFilename);

Modified: libs/swing-misc/trunk/src/net/sf/japi/swing/misc/JFileField.java
===================================================================
--- libs/swing-misc/trunk/src/net/sf/japi/swing/misc/JFileField.java	2007-07-30 20:19:09 UTC (rev 561)
+++ libs/swing-misc/trunk/src/net/sf/japi/swing/misc/JFileField.java	2007-07-30 20:30:49 UTC (rev 562)
@@ -20,33 +20,42 @@
 package net.sf.japi.swing.misc;
 
 import java.awt.FlowLayout;
+import javax.swing.JComponent;
+import javax.swing.JLabel;
 import javax.swing.JTextField;
-import javax.swing.JLabel;
-import javax.swing.JComponent;
 
 /** Component for selecting a file.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  */
 public class JFileField extends JComponent {
 
-    /** The label. */
+    /** The default number of textfield columns. */
+    private static final int DEFAULT_TEXTFIELD_COLUMNS = 16;
+
+    /** The label.
+     * @serial include
+     */
     private final JLabel label;
 
-    /** The file field. */
+    /** The file field.
+     * @serial include
+     */
     private final JTextField fileField;
 
-    /** The button to start the JFileChooser. */
+    /** The button to start the JFileChooser.
+     * @serial include
+     */
     private final JFileChooserButton chooserButton;
 
     /**
      * Create a JFileField.
-     * @param labelText         the text for the label
-     * @param initial           the initial path
-     * @param fileSelectionMode the mode for the file selection
+     * @param labelText          The text for the label.
+     * @param initial            The initial path.
+     * @param fileSelectionMode  The mode for the file selection.
      */
     public JFileField(final String labelText, final String initial, final int fileSelectionMode) {
         setLayout(new FlowLayout(FlowLayout.RIGHT));
-        fileField = new JTextField(initial, 16);
+        fileField = new JTextField(initial, DEFAULT_TEXTFIELD_COLUMNS);
         chooserButton = new JFileChooserButton(fileField, fileSelectionMode);
         label = new JLabel(labelText);
         add(label);

Modified: libs/swing-misc/trunk/src/net/sf/japi/swing/misc/ProgressDisplay.java
===================================================================
--- libs/swing-misc/trunk/src/net/sf/japi/swing/misc/ProgressDisplay.java	2007-07-30 20:19:09 UTC (rev 561)
+++ libs/swing-misc/trunk/src/net/sf/japi/swing/misc/ProgressDisplay.java	2007-07-30 20:30:49 UTC (rev 562)
@@ -19,17 +19,17 @@
 
 package net.sf.japi.swing.misc;
 
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.Component;
+import java.awt.GridLayout;
+import javax.swing.BorderFactory;
 import javax.swing.JDialog;
-import javax.swing.JProgressBar;
+import javax.swing.JFrame;
 import javax.swing.JLabel;
-import javax.swing.JFrame;
 import javax.swing.JPanel;
-import javax.swing.BorderFactory;
+import javax.swing.JProgressBar;
 import javax.swing.SwingConstants;
-import java.awt.GridLayout;
-import java.awt.BorderLayout;
-import java.awt.Component;
-import java.awt.Color;
 
 /** ProgressDisplay handles a popup dialog for the mainview
  * which displays a process progressBar.
@@ -56,6 +56,7 @@
      * @param max    initial maximum of progress points
      * @param text   the initial label text
      */
+    @SuppressWarnings({"MagicNumber"})
     public ProgressDisplay(final JFrame parent, final String title, final int max, final String text) {
         super(parent, title, false);
         setDefaultCloseOperation(DO_NOTHING_ON_CLOSE); // can't close


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.