Menu
▾
▴
[Jboss-svn-commits] JBL Code SVN: r2021 - in trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins: . cc jira svn
|
From: <jbo...@li...> - 2006-01-07 19:10:52
|
Author: wrzep Date: 2006-01-07 14:10:45 -0500 (Sat, 07 Jan 2006) New Revision: 2021 Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/KosmosStatusPlugin.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/OneStatusPlugin.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/Plugin.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/ScorePlugin.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/StatusPlugin.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/cc/CcStatusPlugin.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/jira/JiraStatusPlugin.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/svn/SvnStatusPlugin.java Log: comments and cleanup http://jira.jboss.com/jira/browse/JBLAB-415 Pawel Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/KosmosStatusPlugin.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/KosmosStatusPlugin.java 2006-01-07 18:52:55 UTC (rev 2020) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/KosmosStatusPlugin.java 2006-01-07 19:10:45 UTC (rev 2021) @@ -27,7 +27,6 @@ import org.jboss.logging.Logger; import java.util.HashMap; -import java.util.Iterator; import java.util.Map; import java.util.Properties; @@ -38,7 +37,10 @@ public abstract class KosmosStatusPlugin extends StatusPlugin { - protected abstract String getKosmosServiceProperty(); + /** + * Kosmos-service xml tag. + */ + protected abstract String getKosmosServiceTag(); /** * Binds project ids with kosmos-service specyfic Maps. @@ -59,6 +61,7 @@ projectMaps = new HashMap<String,Map>(); } + @Override public void init(String id, String portalName, Projects projects, Properties properties) throws InvalidPluginPropertiesException { super.init(id, portalName, projects,properties); @@ -80,11 +83,11 @@ "Missing properties for plugin: " + getId() + "."); } - serviceURL = properties.getProperty(getKosmosServiceProperty()); + serviceURL = properties.getProperty(getKosmosServiceTag()); if (serviceURL == null) { throw new InvalidPluginPropertiesException( - "Missing " + getKosmosServiceProperty() + + "Missing " + getKosmosServiceTag() + " property for plugin: " + getId() + "."); } } @@ -115,6 +118,7 @@ /* (non-Javadoc) * @see org.jboss.forge.status.Plugin#getValue(java.lang.String) */ + @Override public long getValue(String projectId) { if (!projectMaps.containsKey(projectId)) { @@ -129,15 +133,4 @@ return getPluginSpecyficValue(projectMap); } - - protected void printMap(Map map) { //debug - if (map != null) { - - for (Iterator iter = map.keySet().iterator(); iter.hasNext();) { - Object obj = (Object) iter.next(); - System.out.println( - "object: " + obj + " binding: " + map.get(obj)); - } - } - } } Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/OneStatusPlugin.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/OneStatusPlugin.java 2006-01-07 18:52:55 UTC (rev 2020) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/OneStatusPlugin.java 2006-01-07 19:10:45 UTC (rev 2021) @@ -24,6 +24,7 @@ /** * @author Pawel Wrzeszcz +* The simplest plugin example. Plugin always returning 1. */ public class OneStatusPlugin extends StatusPlugin { @@ -32,6 +33,6 @@ super(); }; - public long getValue(String projectId) { return -1; } ; + public long getValue(String projectId) { return 1; } ; } Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/Plugin.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/Plugin.java 2006-01-07 18:52:55 UTC (rev 2020) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/Plugin.java 2006-01-07 19:10:45 UTC (rev 2021) @@ -31,7 +31,7 @@ public abstract class Plugin { - /** Node from xml file which holds properties specyfic to this plugin */ + /** Properties specyfic to this plugin */ protected Properties properties; /** Plugin id */ @@ -39,11 +39,11 @@ /** * @param id Plugin id - * @param properties Node with plugin specyfic properties + * @param properties plugin specyfic properties * or null if properties are not specified * @throws InvalidPluginPropertiesException * Thrown when properties passed in <code>propertiesNode</code> - * are incorrect or missed. + * are incorrect or missing. */ public void init(String id, Properties properties) throws InvalidPluginPropertiesException { @@ -61,7 +61,7 @@ public abstract long getValue(String projectId); /** - * @return Plugin id + * @return plugin id */ public String getId() { return id; }; } Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/ScorePlugin.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/ScorePlugin.java 2006-01-07 18:52:55 UTC (rev 2020) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/ScorePlugin.java 2006-01-07 19:10:45 UTC (rev 2021) @@ -25,15 +25,26 @@ import java.util.Map; import java.util.Properties; - /** * @author Pawel Wrzeszcz +* +* Superclass for plugins computing project score +* from values provided by StatusPlugins. */ public abstract class ScorePlugin extends Plugin { protected Map<String,Plugin> plugins; + /** + * @param id Plugin id + * @param plugins Map binding StatusPlugin names with appropriate Plugins + * @param properties plugin specyfic properties + * or null if properties are not specified + * @throws InvalidPluginPropertiesException + * Thrown when properties passed in <code>propertiesNode</code> + * are incorrect or missing. + */ public void init(String id, Map<String, Plugin> plugins, Properties properties) throws InvalidPluginPropertiesException { Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/StatusPlugin.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/StatusPlugin.java 2006-01-07 18:52:55 UTC (rev 2020) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/StatusPlugin.java 2006-01-07 19:10:45 UTC (rev 2021) @@ -28,14 +28,12 @@ /** * @author Pawel Wrzeszcz -* Superclass for the status plugins in the Status Matrix. +* Superclass for plugins providing projects metrics. */ public abstract class StatusPlugin extends Plugin { - /** - * Projects present in the Status Matrix. - */ + /** Projects present in the Status Matrix. */ protected Projects projects; protected String portalName; @@ -44,7 +42,8 @@ * @param name Plugin name * @param id Plugin id * @param projects Projects present in the Status Matrix - * @param propertiesNode Node with plugin specyfic properties + * @param properties plugin specyfic properties + * or null if properties are not specified * @throws InvalidPluginPropertiesException */ public void init(String id, String portalName, Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/cc/CcStatusPlugin.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/cc/CcStatusPlugin.java 2006-01-07 18:52:55 UTC (rev 2020) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/cc/CcStatusPlugin.java 2006-01-07 19:10:45 UTC (rev 2021) @@ -42,7 +42,7 @@ private static final String CC_SERVICE_PROPERTY = "cc-service"; private static final String CC_ADRESS_TAG = "cc-adress"; - protected String getKosmosServiceProperty() { return CC_SERVICE_PROPERTY;}; + protected String getKosmosServiceTag() { return CC_SERVICE_PROPERTY;}; protected Logger log; Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/jira/JiraStatusPlugin.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/jira/JiraStatusPlugin.java 2006-01-07 18:52:55 UTC (rev 2020) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/jira/JiraStatusPlugin.java 2006-01-07 19:10:45 UTC (rev 2021) @@ -43,7 +43,7 @@ private static final String JIRA_SERVICE_PROPERTY = "jira-service"; private static final String JIRA_ADRESS_TAG = "jira-adress"; - protected String getKosmosServiceProperty() { return JIRA_SERVICE_PROPERTY;}; + protected String getKosmosServiceTag() { return JIRA_SERVICE_PROPERTY;}; protected Logger log; Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/svn/SvnStatusPlugin.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/svn/SvnStatusPlugin.java 2006-01-07 18:52:55 UTC (rev 2020) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/plugins/svn/SvnStatusPlugin.java 2006-01-07 19:10:45 UTC (rev 2021) @@ -42,7 +42,7 @@ private static final String SVN_SERVICE_PROPERTY = "svn-service"; private static final String SVN_REPO_ADRESS_TAG = "svn-repo"; - protected String getKosmosServiceProperty() { return SVN_SERVICE_PROPERTY;}; + protected String getKosmosServiceTag() { return SVN_SERVICE_PROPERTY;}; protected Logger log; |
