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.counter;
30  
31  import cppast.AbstractVisitor;
32  
33  /**
34   * Factorizes counters common behaviours.
35   *
36   * @author Mathieu Champlon
37   */
38  public class AbstractCounter extends AbstractVisitor implements Counter
39  {
40      private final String label;
41      private final CounterObserver observer;
42      private int count;
43  
44      /**
45       * Create an abstract counter.
46       *
47       * @param label the name of the measure
48       * @param observer a counter observer
49       */
50      public AbstractCounter( final String label, final CounterObserver observer )
51      {
52          if( observer == null )
53              throw new IllegalArgumentException( "argument 'observer' is null" );
54          this.label = label;
55          this.observer = observer;
56          this.count = 0;
57      }
58  
59      /**
60       * {@inheritDoc}
61       */
62      public final void flush( final String item, final int line )
63      {
64          observer.notify( label, item, line, count );
65          count = 0;
66      }
67  
68      /**
69       * Increments the counter.
70       */
71      protected final void increment()
72      {
73          ++count;
74      }
75  }