Initializing help system before first use

# AbstractBarIterationListener

- java.lang.Object
- - com.dashoptimization.AbstractBarIterationListener

- All Implemented Interfaces:
    `XPRSbarIterationListener`, `java.util.EventListener`

      public abstract class AbstractBarIterationListener
      extends java.lang.Object
      implements XPRSbarIterationListener

  Convenience implementation of `XPRSbarIterationListener`. This class has a more convenient `barIterationEvent(XPRSprob)` function than the interface.

- - ### Constructor Summary

    Constructor | Description
    --- | ---
    `AbstractBarIterationListener()` |

  - ### Method Summary

    Modifier and Type | Method | Description
    --- | --- | ---
    `abstract int` | `barIterationEvent​(XPRSprob prob)` | Invoke the callback.
    `void` | `XPRSbarIterationEvent​(XPRSprob prob, java.lang.Object vContext, IntHolder barrier_action)` | Handle a `BarIteration` event.

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### AbstractBarIterationListener

          public AbstractBarIterationListener()

  - ### Method Detail

    - #### XPRSbarIterationEvent

          public final void XPRSbarIterationEvent​(XPRSprob prob,
                                                  java.lang.Object vContext,
                                                  IntHolder barrier_action)

      Description copied from interface: `XPRSbarIterationListener`
      Handle a `BarIteration` event. More details about `BarIteration` events can be found in the documentation of the corresponding C callback.
      Specified by:
        `XPRSbarIterationEvent` in interface `XPRSbarIterationListener`
      Parameters:
        `prob` - The problem passed to the callback function, `bariteration`.
        `vContext` - The user-defined data passed as `data` when setting up the callback.
        `barrier_action` - Defines a return value controlling barrier:
        - `<0`: continue with the next iteration;
        - `=0`: let barrier decide (use default stopping criteria);
        - `1`: barrier stops with status not defined;
        - `2`: barrier stops with optimal status;
        - `3`: barrier stops with dual infeasible status;
        - `4`: barrier stops wih primal infeasible status.
      See Also:
        C documentation of XPRSaddcbbariteration()

    - #### barIterationEvent

          public abstract int barIterationEvent​(XPRSprob prob)

      Invoke the callback.
      Parameters:
        `prob` - The problem on which the callback is invoked.
      Returns:
        the next action to perform (return 0 for the default). See the C reference manual for `XPRSaddcbbariteration()` for details about how values are interpreted.

Parent Topic Class Summary

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.