You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by pm...@apache.org on 2014/11/22 20:13:26 UTC

svn commit: r1641106 - /jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java

Author: pmouawad
Date: Sat Nov 22 19:13:26 2014
New Revision: 1641106

URL: http://svn.apache.org/r1641106
Log:
Fix javadocs

Modified:
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java?rev=1641106&r1=1641105&r2=1641106&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java Sat Nov 22 19:13:26 2014
@@ -77,6 +77,7 @@ public abstract class AbstractBackendLis
 
     /**
      * Get a Logger instance which can be used by subclasses to log information.
+     * As this class is designed to be subclassed this is useful.
      *
      * @return a Logger instance which can be used for logging
      */
@@ -94,9 +95,8 @@ public abstract class AbstractBackendLis
     }
 
     /**
-     * 
-     * @param sampleLabel
-     * @return SamplerMetric
+     * @param sampleLabel Name of sample used as key
+     * @return {@link SamplerMetric}
      */
     protected SamplerMetric getSamplerMetric(String sampleLabel) {
         SamplerMetric samplerMetric = metricsPerSampler.get(sampleLabel);
@@ -111,8 +111,7 @@ public abstract class AbstractBackendLis
     }
     
     /**
-     * 
-     * @return Map<String, SamplerMetric>
+     * @return Map where key is SampleLabel and {@link SamplerMetric} is the metrics of this Sample
      */
     protected Map<String, SamplerMetric> getMetricsPerSampler() {
         return metricsPerSampler;

Re: svn commit: r1641106 - /jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java

Posted by sebb <se...@gmail.com>.
On 22 November 2014 at 19:13,  <pm...@apache.org> wrote:
> Author: pmouawad
> Date: Sat Nov 22 19:13:26 2014
> New Revision: 1641106
>
> URL: http://svn.apache.org/r1641106
> Log:
> Fix javadocs
>
> Modified:
>     jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java
>
> Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java
> URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java?rev=1641106&r1=1641105&r2=1641106&view=diff
> ==============================================================================
> --- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java (original)
> +++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/AbstractBackendListenerClient.java Sat Nov 22 19:13:26 2014
> @@ -77,6 +77,7 @@ public abstract class AbstractBackendLis
>
>      /**
>       * Get a Logger instance which can be used by subclasses to log information.
> +     * As this class is designed to be subclassed this is useful.

I'm not sure it's a good idea to use the same logger for multiple classes.

The log message includes the class name, so it makes it harder to find
where the log is actually generated.
Also it's not possible to change the level for each class independently.

If we really do wish to share the logger with sub-classes, I think the
name should have a different syntax so it is obvious that the log may
come from any sub-class.

>       *
>       * @return a Logger instance which can be used for logging
>       */
> @@ -94,9 +95,8 @@ public abstract class AbstractBackendLis
>      }
>
>      /**
> -     *
> -     * @param sampleLabel
> -     * @return SamplerMetric
> +     * @param sampleLabel Name of sample used as key
> +     * @return {@link SamplerMetric}
>       */
>      protected SamplerMetric getSamplerMetric(String sampleLabel) {
>          SamplerMetric samplerMetric = metricsPerSampler.get(sampleLabel);
> @@ -111,8 +111,7 @@ public abstract class AbstractBackendLis
>      }
>
>      /**
> -     *
> -     * @return Map<String, SamplerMetric>
> +     * @return Map where key is SampleLabel and {@link SamplerMetric} is the metrics of this Sample
>       */
>      protected Map<String, SamplerMetric> getMetricsPerSampler() {
>          return metricsPerSampler;
>
>