DPML Notify

[mcconnell AT dpml.net]

Author: mcconnell AT dpml.net
Date: Fri May 13 12:36:32 2005
New Revision: 2540

Modified:
   
development/main/depot/console/src/main/net/dpml/depot/console/DepotClassLoader.java
   
development/main/depot/console/src/main/net/dpml/depot/console/Environment.java
   
development/main/depot/console/src/main/net/dpml/depot/console/EnvironmentException.java
   development/main/depot/console/src/main/net/dpml/depot/console/Main.java
   
development/main/depot/console/src/main/net/dpml/depot/console/PropertyResolver.java
   
development/main/depot/station/src/main/net/dpml/depot/prefs/CachePanel.java
   
development/main/depot/station/src/main/net/dpml/depot/prefs/DepotDialog.java
   
development/main/depot/station/src/main/net/dpml/depot/prefs/GenericTableModel.java
Log:
javadocing

Modified: 
development/main/depot/console/src/main/net/dpml/depot/console/DepotClassLoader.java
==============================================================================
--- 
development/main/depot/console/src/main/net/dpml/depot/console/DepotClassLoader.java
        (original)
+++ 
development/main/depot/console/src/main/net/dpml/depot/console/DepotClassLoader.java
        Fri May 13 12:36:32 2005
@@ -1,5 +1,5 @@
 /*
- * Copyright 2004 Stephen J. McConnell.
+ * Copyright 2005 Stephen J. McConnell.
  *
  * Licensed  under the  Apache License,  Version 2.0  (the "License");
  * you may not use  this file  except in  compliance with the License.
@@ -29,7 +29,11 @@
 import java.net.URLClassLoader;
 
 /**
- * CLI hander for the depot package.
+ * The DepotClassLoader is a URLClassLoader that supports late binding of 
the 
+ * URLs it contains.  This class is used by the Depot CLI scripts as the 
system
+ * classloader and is supplied with a preferences node that contains a set 
of 
+ * attributes.  The values of each attribute are resolved to URLs and added 
to 
+ * system classloader at the time of application deployment.
  *
  * @author <a href="http://www.dpml.net";>The Digital Product Meta Library</a>
  * @version $Id: Main.java 2480 2005-05-10 04:44:32Z mcconnell AT dpml.net $
@@ -38,11 +42,30 @@
 {
     private boolean m_sealed = false;
 
+   /**
+    * Creation of a new Depot classloader.
+    *
+    * @param parent the parent classloader
+    */
     public DepotClassLoader( ClassLoader parent )
     {
         super( new URL[0], parent );
     }
 
+   /**
+    * Assignment of a preferences object to the classloader from which 
+    * urls shall be resolved.  The implementation resolves urls values 
+    * by converting all attribute values in the supplied preference node to 
+    * URLs. On completion of the classloader is marked as sealed and no 
+    * further modification can be performed.
+    *
+    * @param prefs a preferences node describing the classpath
+    * @exception IllegalStateException if the classloader is sealed
+    * @exception IOException if an error occurs in the resolution of a URL
+    *    from an attribute value
+    * @exception BackingStoreException if the backing store for the supplied 
+    *    preferences node is not reachable
+    */
     void setProfileClasspathNode( Preferences prefs ) throws 
BackingStoreException, IOException
     {
         if( m_sealed )

Modified: 
development/main/depot/console/src/main/net/dpml/depot/console/Environment.java
==============================================================================
--- 
development/main/depot/console/src/main/net/dpml/depot/console/Environment.java
     (original)
+++ 
development/main/depot/console/src/main/net/dpml/depot/console/Environment.java
     Fri May 13 12:36:32 2005
@@ -1,5 +1,5 @@
 /*
- * Copyright 2004 Stephen J. McConnell.
+ * Copyright 2004-2005 Stephen J. McConnell.
  * Copyright 2004 Apache Software Foundation
  *
  * Licensed  under the  Apache License,  Version 2.0  (the "License");
@@ -35,7 +35,7 @@
  * @author <a href="http://www.dpml.net";>The Digital Product Meta Library</a>
  * @version $Id: Environment.java 2445 2005-04-28 23:44:22Z 
niclas AT hedhman.org $
  */
-public class Environment extends Properties
+class Environment extends Properties
 {
    /**
     * os.name System property

Modified: 
development/main/depot/console/src/main/net/dpml/depot/console/EnvironmentException.java
==============================================================================
--- 
development/main/depot/console/src/main/net/dpml/depot/console/EnvironmentException.java
    (original)
+++ 
development/main/depot/console/src/main/net/dpml/depot/console/EnvironmentException.java
    Fri May 13 12:36:32 2005
@@ -1,5 +1,5 @@
 /*
- * Copyright 2004 Stephen J. McConnell.
+ * Copyright 2004-2005 Stephen J. McConnell.
  *
  * Licensed  under the  Apache License,  Version 2.0  (the "License");
  * you may not use  this file  except in  compliance with the License.
@@ -25,7 +25,7 @@
  * @author <a href="http://www.dpml.net";>The Digital Product Meta Library</a>
  * @version $Id: EnvironmentException.java 2445 2005-04-28 23:44:22Z 
niclas AT hedhman.org $
  */
-public class EnvironmentException extends RuntimeException
+class EnvironmentException extends RuntimeException
 {
    /**
     * the environment variable name if available

Modified: 
development/main/depot/console/src/main/net/dpml/depot/console/Main.java
==============================================================================
--- development/main/depot/console/src/main/net/dpml/depot/console/Main.java  
  (original)
+++ development/main/depot/console/src/main/net/dpml/depot/console/Main.java  
  Fri May 13 12:36:32 2005
@@ -1,5 +1,5 @@
 /*
- * Copyright 2004 Stephen J. McConnell.
+ * Copyright 2005 Stephen J. McConnell.
  *
  * Licensed  under the  Apache License,  Version 2.0  (the "License");
  * you may not use  this file  except in  compliance with the License.
@@ -57,8 +57,6 @@
         System.setProperty( "java.util.logging.config.class", 
"net.dpml.depot.logging.ConfigurationHandler" );
     }
 
-    private static String DEPOT_STATION_CLASSPATH = 
"@DEPOT-STATION-CLASSPATH@";
-
    /**
     * DPML home key.
     */
@@ -75,21 +73,11 @@
     public static final String PREFS_KEY =           "dpml.prefs";
 
    /**
-    * Transit system key.
+    * DPML system key.
     */
     public static final String SYSTEM_KEY =          "dpml.system";
 
    /**
-    * DPML environment variable string.
-    */
-    public static final String HOME_SYMBOL =         "DPML_HOME";
-
-   /**
-    * DPML environment variable string.
-    */
-    public static final String SYSTEM_SYMBOL =       "DPML_SYSTEM";
-
-   /**
     * The DPML home directory established via assesment of the the 
${dpml.home}
     * system property and the DPML_HOME environment variable.  If neither are
     * defined the behaviour is platform specific.  If the os is Windows,
@@ -412,6 +400,16 @@
     }
 
    /**
+    * DPML environment variable string.
+    */
+    private static final String HOME_SYMBOL = "DPML_HOME";
+
+   /**
+    * DPML environment variable string.
+    */
+    private static final String SYSTEM_SYMBOL = "DPML_SYSTEM";
+
+   /**
     * Constructor (disabled).
     */
     private Main()

Modified: 
development/main/depot/console/src/main/net/dpml/depot/console/PropertyResolver.java
==============================================================================
--- 
development/main/depot/console/src/main/net/dpml/depot/console/PropertyResolver.java
        (original)
+++ 
development/main/depot/console/src/main/net/dpml/depot/console/PropertyResolver.java
        Fri May 13 12:36:32 2005
@@ -26,7 +26,7 @@
  * Utility class that handles substitution of property names in the string
  * for ${value} relative to a supplied set of properties.
  */
-public final class PropertyResolver
+final class PropertyResolver
 {
     // 
------------------------------------------------------------------------
     // static

Modified: 
development/main/depot/station/src/main/net/dpml/depot/prefs/CachePanel.java
==============================================================================
--- 
development/main/depot/station/src/main/net/dpml/depot/prefs/CachePanel.java  
      (original)
+++ 
development/main/depot/station/src/main/net/dpml/depot/prefs/CachePanel.java  
      Fri May 13 12:36:32 2005
@@ -69,7 +69,7 @@
  *
  * @author <a href="mailto:mcconnell AT osm.net";>OSM</a>
  */
-public class CachePanel extends JPanel implements PreferenceChangeListener, 
PropertyChangeListener
+class CachePanel extends JPanel implements PreferenceChangeListener, 
PropertyChangeListener
 {
     //--------------------------------------------------------------
     // static

Modified: 
development/main/depot/station/src/main/net/dpml/depot/prefs/DepotDialog.java
==============================================================================
--- 
development/main/depot/station/src/main/net/dpml/depot/prefs/DepotDialog.java 
      (original)
+++ 
development/main/depot/station/src/main/net/dpml/depot/prefs/DepotDialog.java 
      Fri May 13 12:36:32 2005
@@ -62,6 +62,9 @@
 import net.dpml.transit.Transit;
 
 /**
+ * Dialog that presents the default preferences for DPML applications 
including
+ * Transit cache and repository settings, transit content handler plugins, 
logging
+ * preferences and application profiles runnable via the depot command line 
script.
  */
 public class DepotDialog extends JDialog 
 {

Modified: 
development/main/depot/station/src/main/net/dpml/depot/prefs/GenericTableModel.java
==============================================================================
--- 
development/main/depot/station/src/main/net/dpml/depot/prefs/GenericTableModel.java
 (original)
+++ 
development/main/depot/station/src/main/net/dpml/depot/prefs/GenericTableModel.java
 Fri May 13 12:36:32 2005
@@ -36,7 +36,7 @@
 import net.dpml.transit.host.ResourceHost;
 
 /**
- * Table model used to manage features of an adapter.
+ * Table model that maps table rows to child nodes of a supplied preferences 
node.
  */
 public class GenericTableModel extends AbstractTableModel implements 
NodeChangeListener
 {