SimpleCounter.java

/*
** Module   : SimpleCounter.java
** Abstract : Helper class for an optional accumulating <code>long</code> values. 
**
** Copyright (c) 2020-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 IAS 20200930 Created initial version.
** 002 IAS 20201001 Added dump of MBean state.
**     HC  20201010 Implemented map counter.
**     CA  20221031 Ensure this is enabled if this is created after the associated mbean is enabled.
** 003 HC  20240222 Enabled JMX on FWD Client.
*/ 

/*
** 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.util.function.*;

import com.goldencode.p2j.jmx.FwdServerJMX.Counter;

/** Helper class for an optional accumulating <code>long</code> values.*/
public class SimpleCounter
extends AbstractCounter
{
   /** Samples' consumer */
   protected final LongConsumer publish;

   /**
    * Create and register instance
    * @param    counter
    *           Counter MBean
    * @return   new <code>SimpleCounter</code> instance
    */
   public static SimpleCounter getInstance(Counter counter) 
   {
       SimpleCounter simple = new SimpleCounter(counter::update);
       simple.setEnabler(simple::setEnabled); //prevent GC
       simple.setEnabled(counter.getCounter().isEnabled());
       counter.register(simple.getEnabler());
       return simple;
   }

   /**
    * Constructor
    * @param publish
    *        samples' consumer
    */
   protected SimpleCounter(LongConsumer publish) 
   {
      this.publish = publish;
   }
   
   /**
    * Update counter
    * @param value
    *        new value
    */
   public void update(long value)
   {
      if (enabled)
      {
         publish.accept(value);
      }
   }
}