[Jboss-svn-commits] JBL Code SVN: r1852 - trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status

[<jbo...@li...>]

Author: wrzep
Date: 2005-12-18 17:44:22 -0500 (Sun, 18 Dec 2005)
New Revision: 1852

Modified:
   trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Plugins.java
   trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java
Log:
more comments

http://jira.jboss.com/jira/browse/JBLAB-415

Pawel


Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Plugins.java
===================================================================
--- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Plugins.java	2005-12-18 22:36:44 UTC (rev 1851)
+++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Plugins.java	2005-12-18 22:44:22 UTC (rev 1852)
@@ -67,8 +67,8 @@
 	
 	/**
 	 * @param pluginsNode Node with plugins definitions
-	 * @param projects Projects present in the Status Matrix.
-	 * @param scorePlugins flag indicating whether plugins are ScorePlugins.
+	 * @param projects Projects present in the Status Matrix
+	 * @param scorePlugins flag indicating whether plugins are ScorePlugins
 	 */
 	public Plugins(Node pluginsNode, Projects projects, boolean scorePlugins) {
 		
@@ -79,9 +79,16 @@
 		allPlugins = new HashMap<String,Plugin>();
 		statusPlugins = new HashMap<String,Plugin>();
 
-		putAll(pluginsNode, scorePlugins);
+		addAll(pluginsNode, scorePlugins);
 	}
 	
+	/**
+	 * For the given Node, describing the Plugin, returns Plugin instance.
+	 * 
+	 * @param pluginNode Node with Plugin definition
+	 * @param scorePlugin flag indicating whether plugin should be ScorePlugin
+	 * @return Plugin defined in the <code>pluginNode</code>
+	 */
 	private Plugin getPlugin(Node pluginNode, boolean scorePlugin) {
 		
 		// Get plugin info from pluginNode
@@ -108,7 +115,7 @@
 			
 			if (scorePlugin) {
 				((ScorePlugin) plugin).init(pluginName, pluginId, statusPlugins, pluginSpecificPropertiesNode);
-			} else { /* score plugin */
+			} else { /* status plugin */
 				((StatusPlugin) plugin).init(pluginName, pluginId, projects, pluginSpecificPropertiesNode);
 			}	
 			
@@ -126,12 +133,22 @@
 		return plugin;
 	}
 
+	/**
+	 * @param pluginId
+	 * @return Plugin with the given <code>pluginId</code>
+	 */
 	public Plugin get(String pluginId) {
 		
 		return allPlugins.get(pluginId);
 	}
 
-	public void putAll(Node pluginsNode, boolean scorePlugins) {
+	/**
+	 * Adds Plugins described in the pluginsNode.
+	 * 
+	 * @param pluginsNode Node with plugins definitions
+	 * @param scorePlugins flag indicating whether plugins are ScorePlugins
+	 */
+	public void addAll(Node pluginsNode, boolean scorePlugins) {
 		
 		NodeList pluginNodes = pluginsNode.getChildNodes();
 		

Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java
===================================================================
--- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java	2005-12-18 22:36:44 UTC (rev 1851)
+++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java	2005-12-18 22:44:22 UTC (rev 1852)
@@ -59,7 +59,7 @@
 		
 		// Get the status and score plugins
 		plugins = new Plugins(statusPluginsRoot, projects, false);
-		plugins.putAll(scorePluginsRoot, true);	
+		plugins.addAll(scorePluginsRoot, true);	
 		
 		// Get columns to display
 		Node pageRoot = XmlTools.getFirstNodeWithName(statusRoot, MAIN_PAGE_COLLUMNS_TAG);