SimpleLongCounter.java

/*
** Module   : SimpleLongCounter.java
** Abstract : MBean supporting counting 
**
** Copyright (c) 2020, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 IAS 20200930 Created initial version.
** 002 IAS 20201001 Added dump of MBean state.
*/ 

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.jmx;

import java.io.*;
import java.nio.file.*;
import java.text.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.concurrent.atomic.*;

/** MBean supporting counting */
public class SimpleLongCounter 
extends Facultative 
implements SimpleLongCounterMBean, 
           LongCounter 
{
   /** Total sum of samples */
   private final AtomicLong total = new AtomicLong(0);

   /** Total number of calls */
   private final AtomicLong count = new AtomicLong(0);
   
   /**
    * Reset counters
    */
   @Override
   public synchronized void reset()
   {
      total.set(0);
      count.set(0);
   }

   /**
    * Get sum of samples 
    * @return sum of samples
    */
   @Override
   public long getTotal()
   {
      return total.get();
   }

   /**
    * Get number of calls
    * @return number of calls
    */
   @Override
   public long getCount()
   {
      return count.get();
   }

   /** 
    * @see com.goldencode.p2j.jmx.LongCounter#update(long)
    */
   @Override
   public void update(long value)
   {
      total.addAndGet(value);
      count.incrementAndGet();
   }

   /**
    * Print counters' values to the file
    * @param file 
    *        output file name (will be appended if exists)
    * @throws IOException 
    *         on I/O error
    */
   @Override
   public void print(String file) throws IOException
   {
      dump(getAnnotation(), file);
   }

   /**
    * Print counters' values to the file
    * @param comment 
    *        comment
    * @param file 
    *        output file name (will be appended if exists)
    * @throws IOException 
    *         on I/O error
    */
   public void print(String comment, String file) throws IOException
   {
      dump(comment, file);
   }

   /**
    * Return the string representation of the counter
    * 
    * @param ts
    *        timestamp string 
    * @param comment
    *        comment
    * @return string representation of the counter
    * @throws IOException
    *         on I/O error
    */
   public String toString(String ts, String comment)  throws IOException
   {
      return isEnabled() ? String.format("[%s] %s (count/total):\t %d/%d", 
                                 ts, comment, count.get(), total.get()) :
                           String.format("[%s] %s: disabled", ts, comment);
   }
}