[Japi-cvs] SF.net SVN: japi:[723] libs/swing-prefs/trunk/src

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

Revision: 723
          http://japi.svn.sourceforge.net/japi/?rev=723&view=rev
Author:   christianhujer
Date:     2008-11-30 17:54:26 +0000 (Sun, 30 Nov 2008)

Log Message:
-----------
Minor improvements, mainly documentation and for better unit testing.

Modified Paths:
--------------
    libs/swing-prefs/trunk/src/prj/net/sf/japi/swing/prefs/Prefs.java
    libs/swing-prefs/trunk/src/tst/test/net/sf/japi/swing/prefs/MockActionBuilder.java
    libs/swing-prefs/trunk/src/tst/test/net/sf/japi/swing/prefs/PreferencesPaneTest.java

Modified: libs/swing-prefs/trunk/src/prj/net/sf/japi/swing/prefs/Prefs.java
===================================================================
--- libs/swing-prefs/trunk/src/prj/net/sf/japi/swing/prefs/Prefs.java	2008-11-30 17:50:48 UTC (rev 722)
+++ libs/swing-prefs/trunk/src/prj/net/sf/japi/swing/prefs/Prefs.java	2008-11-30 17:54:26 UTC (rev 723)
@@ -32,16 +32,20 @@
  */
 public interface Prefs {
 
-    /** Apply the changes in the UI to get into effect / be stored. */
+    /** Applies the changes in the UI to get into effect / be stored.
+     * The implementation should read all widget states and apply the corresponding settings on the application.
+     */
     void apply();
 
-    /** Revert the preferences to the default values. */
+    /** Reverts the preferences to their default values.
+     * The implementation should reset all widgets to a default state as if neither there were preferences nor the user changed anything.
+     */
     void defaults();
 
-    /** Provide a component for editing the prefs.
+    /** Provides a component for editing the prefs.
      * The edit component MUST NOT automatically change preferences itself.
      * Preferences MUST only changed when the method {@link #apply()} is invoked.
-     * @return component for editing the prefs
+     * @return component for editing the preferences.
      */
     JComponent getEditComponent();
 

Modified: libs/swing-prefs/trunk/src/tst/test/net/sf/japi/swing/prefs/MockActionBuilder.java
===================================================================
--- libs/swing-prefs/trunk/src/tst/test/net/sf/japi/swing/prefs/MockActionBuilder.java	2008-11-30 17:50:48 UTC (rev 722)
+++ libs/swing-prefs/trunk/src/tst/test/net/sf/japi/swing/prefs/MockActionBuilder.java	2008-11-30 17:54:26 UTC (rev 723)
@@ -22,9 +22,26 @@
 import net.sf.japi.swing.DefaultActionBuilder;
 
 /**
- * Created by IntelliJ IDEA.
+ * The MockActionBuilder is a replacement of {@link DefaultActionBuilder} for testing purposes.
+ * All methods of {@link DefaultActionBuilder} that would require user interaction are replaced by this Mock's robot.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  */
 public class MockActionBuilder extends DefaultActionBuilder {
 
+    /** Create an empty MockActionBuilder.
+     * Not recommended.
+     * @see DefaultActionBuilder#DefaultActionBuilder()
+     */
+    public MockActionBuilder() {
+        super();
+    }
+
+    /** Create a MockActionBuilder with the specified key.
+     * @param key Key for which to create a MockActionBuilder.
+     * @see DefaultActionBuilder#DefaultActionBuilder(String)
+     */
+    public MockActionBuilder(final String key) {
+        super(key);
+    }
+
 } // class MockActionBuilder

Modified: libs/swing-prefs/trunk/src/tst/test/net/sf/japi/swing/prefs/PreferencesPaneTest.java
===================================================================
--- libs/swing-prefs/trunk/src/tst/test/net/sf/japi/swing/prefs/PreferencesPaneTest.java	2008-11-30 17:50:48 UTC (rev 722)
+++ libs/swing-prefs/trunk/src/tst/test/net/sf/japi/swing/prefs/PreferencesPaneTest.java	2008-11-30 17:54:26 UTC (rev 723)
@@ -33,8 +33,8 @@
 public class PreferencesPaneTest {
 
     @BeforeClass
-    public void setUpSuite() {
-        ActionBuilderFactory.getInstance().putActionBuilder("net.sf.japi.swing.prefs", new MockActionBuilder());
+    public static void setUpSuite() {
+        ActionBuilderFactory.getInstance().putActionBuilder("net.sf.japi.swing.prefs", new MockActionBuilder("net.sf.japi.swing.prefs"));
     }
 
     /** Tests that when selecting another preferences for changed preferences, "no" will revert the changes.


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