[zb4osgi-changeset] [scm] ZigBee 4 OSGi repository change: r1106 - /projects/zb4osgi/trunk/zigbee.ha.driver/src/main/java/it/cnr/isti/zigbee/ha/driver/core/ReportingConfiguration.java

[scm-notify at zb4osgi.aaloa.org]

Author: stefano.lenzi
Date: Mon Nov 17 23:38:44 2014
New Revision: 1106

Log:
Improved Javadoc documentation for method getReportingOverwrite() ( refs #279 )


Modified:
    projects/zb4osgi/trunk/zigbee.ha.driver/src/main/java/it/cnr/isti/zigbee/ha/driver/core/ReportingConfiguration.java

Modified: projects/zb4osgi/trunk/zigbee.ha.driver/src/main/java/it/cnr/isti/zigbee/ha/driver/core/ReportingConfiguration.java
==============================================================================
--- projects/zb4osgi/trunk/zigbee.ha.driver/src/main/java/it/cnr/isti/zigbee/ha/driver/core/ReportingConfiguration.java	(original)
+++ projects/zb4osgi/trunk/zigbee.ha.driver/src/main/java/it/cnr/isti/zigbee/ha/driver/core/ReportingConfiguration.java	Mon Nov 17 23:38:44 2014
@@ -21,6 +21,8 @@
 */
 
 package it.cnr.isti.zigbee.ha.driver.core;
+
+import it.cnr.isti.zigbee.zcl.library.api.core.ReportListener;
 
 import org.osgi.framework.Constants;
 import org.osgi.service.cm.ManagedService;
@@ -96,6 +98,12 @@
 
 	public abstract double getReportingChange();
 
+	/**
+	 * If the method return <code>false</code> then no reporting configuration will be configured as long as
+	 * there are active {@link ReportListener}, otherwise the configuration will be always overwritten 
+	 * 
+	 * @return true if the reporting should overwrite pre-existing configuration
+	 */
 	public abstract boolean getReportingOverwrite();
 
 }