Package net.ssehub.easy.instantiation.core.model.defaultInstantiators

Class ProgressNotifier

  • All Implemented Interfaces:
    IVilType
    public class ProgressNotifier
extends java.lang.Object
implements IVilType
    Allows VIL/VTL to notify the user about actual progress.
    Author:
    Holger Eichelberger

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void notifyProgress​(int actual, int max)
      Notifies the tracer about the actual process in order to inform the user.
      static void notifyProgress​(int actual, int max, java.lang.String description)
      Notifies the tracer about the actual process in order to inform the user.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ProgressNotifier

        public ProgressNotifier()

    • Method Detail

      • notifyProgress

        public static void notifyProgress​(int actual,
                                  int max)
        Notifies the tracer about the actual process in order to inform the user.
        Parameters:
        actual - the actual step (negative disables display)
        max - the maximum number of steps (may vary over time, negative disables display)

      • notifyProgress

        public static void notifyProgress​(int actual,
                                  int max,
                                  java.lang.String description)
        Notifies the tracer about the actual process in order to inform the user.
        Parameters:
        actual - the actual step (negative disables display)
        max - the maximum number of steps (may vary over time, negative disables display)
        description - an optional description of the step