Interface History

    • Method Detail

      • clear

        void clear()
        Clears the model history. See also Model.resetHist() for how to generate a shorter, but still functional history.
      • complete

        void complete​(boolean isComplete)
        Enables or disables history logging for certain methods where the arguments typically are very large objects.
        Parameters:
        isComplete - true for complete logging.
      • disable

        void disable()
        Disables logging of top-level API calls to the history. Use this method sparingly; the normal state is that everything should be logged. The recommended usage pattern is to use a try-finally block as follows:
            try {
              model.hist().disable();
              // perform transient operations here but do not log them
              // ...
            } finally {
              model.hist().enable();
            }
          
        Calling disable() can be viewed as adding an entry to a stack of disable records; logging will only occur if the stack is empty.
      • enable

        void enable()
        Removes the most recent disabling of top-level API calls to the history. Calling enable() can be viewed as removing an entry from a stack of disable records; logging will only occur if the stack is empty.
      • isComplete

        boolean isComplete()
        Checks if the history logging performs complete logging.
        Returns:
        true if logging is complete.