程序包 org.hipparchus.util

类 Incrementor

java.lang.Object
org.hipparchus.util.Incrementor
public class Incrementor extends Object
Utility that increments a counter until a maximum is reached, at which point, the instance will by default throw a MathIllegalStateException. However, the user is able to override this behaviour by defining a custom callback, in order to e.g. select which exception must be thrown.

  • 构造器详细资料

  • 方法详细资料

    • withCount

      public Incrementor withCount(int value)
      创建一个新实例并将计数器设置为给定值。
      参数:
      value - 计数器的值。
      返回:
      一个新实例。

    • withMaximalCount

      public Incrementor withMaximalCount(int max)
      创建一个新实例并将计数器设置为给定的最大计数。计数器将重置为0。
      参数:
      max - 最大计数。
      返回:
      一个新实例。
      抛出:
      MathIllegalArgumentException - 如果max为负数。

    • withCallback

      public Incrementor withCallback(Incrementor.MaxCountExceededCallback cb)
      创建一个新实例并设置计数器为给定的值。计数器将重置为0。
      参数:
      cb - 在计数器耗尽时要调用的回调。
      返回:
      一个新实例。

    • getMaximalCount

      public int getMaximalCount()
      获取计数器的上限。
      返回:
      计数器的上限。

    • getCount

      public int getCount()
      获取当前计数。
      返回:
      当前计数。

    • canIncrement

      public boolean canIncrement()
      检查是否允许递增计数器nTimes。
      返回:
      如果调用increment()将触发MathIllegalStateException，则返回false，否则返回true。

    • canIncrement

      public boolean canIncrement(int nTimes)
      检查是否允许多次递增计数器。
      参数:
      nTimes - 递增次数。
      返回:
      如果调用increment(nTimes)将调用callback，则返回false，否则返回true。
      抛出:
      MathIllegalArgumentException - 如果nTimes为负数。

    • increment

      public void increment(int nTimes)
      执行多次递增。
      参数:
      nTimes - 递增次数。
      抛出:
      MathIllegalArgumentException - 如果nTimes为负数。
      另请参阅:

    • increment

      public void increment()
      将递增值添加到当前迭代计数中。在计数器耗尽时，此方法将调用传递给withCallback(MaxCountExceededCallback)方法的回调对象的trigger方法。
      另请参阅:

    • reset

      public void reset()
      将计数器重置为0。