View Javadoc

1   /**
2    * Redistribution  and use  in source  and binary  forms, with  or without
3    * modification, are permitted provided  that the following conditions are
4    * met :
5    *
6    * . Redistributions  of  source  code  must  retain  the  above copyright
7    *   notice, this list of conditions and the following disclaimer.
8    *
9    * . Redistributions in  binary form  must reproduce  the above  copyright
10   *   notice, this list of conditions  and the following disclaimer in  the
11   *   documentation and/or other materials provided with the distribution.
12   *
13   * . The name of the author may not be used to endorse or promote products
14   *   derived from this software without specific prior written permission.
15   *
16   * THIS SOFTWARE IS  PROVIDED BY THE  AUTHOR ``AS IS''  AND ANY EXPRESS  OR
17   * IMPLIED  WARRANTIES,  INCLUDING,  BUT   NOT  LIMITED  TO,  THE   IMPLIED
18   * WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE ARE
19   * DISCLAIMED.  IN NO  EVENT SHALL  THE AUTHOR  BE LIABLE  FOR ANY  DIRECT,
20   * INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL  DAMAGES
21   * (INCLUDING,  BUT  NOT LIMITED  TO,  PROCUREMENT OF  SUBSTITUTE  GOODS OR
22   * SERVICES;  LOSS  OF USE,  DATA,  OR PROFITS;  OR  BUSINESS INTERRUPTION)
23   * HOWEVER CAUSED  AND ON  ANY THEORY  OF LIABILITY,  WHETHER IN  CONTRACT,
24   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25   * ANY  WAY  OUT OF  THE  USE OF  THIS  SOFTWARE, EVEN  IF  ADVISED OF  THE
26   * POSSIBILITY OF SUCH DAMAGE.
27   */
28  
29  package cppncss.measure;
30  
31  /**
32   * Sums a series of values.
33   *
34   * @author Mathieu Champlon
35   */
36  public final class Sum
37  {
38      private final String label;
39      private long sum;
40  
41      /**
42       * Create a sum.
43       *
44       * @param label the measurement label
45       * @param value the initial value of the sum
46       */
47      public Sum( final String label, final int value )
48      {
49          this.label = label;
50          this.sum = value;
51      }
52  
53      /**
54       * Add a value to the sum.
55       * <p>
56       * If the label does not match the label given at creation the measurement is ignored.
57       *
58       * @param label the label of the measurement
59       * @param value the value of the measurement
60       * @return whether the measurement has been accepted or not
61       */
62      public boolean update( final String label, final int value )
63      {
64          if( !this.label.equals( label ) )
65              return false;
66          sum += value;
67          return true;
68      }
69  
70      /**
71       * Accept a visitor.
72       *
73       * @param observer an average observer
74       */
75      public void accept( final SumObserver observer )
76      {
77          observer.notify( label, sum );
78      }
79  }