Package fmpp

Interface ProgressListener

    • Field Detail

      • EVENT_BEGIN_PROCESSING_SESSION

        static final int EVENT_BEGIN_PROCESSING_SESSION
        Engine.process has started the work.
        See Also:
        Constant Field Values
      • EVENT_END_PROCESSING_SESSION

        static final int EVENT_END_PROCESSING_SESSION
        Engine.process has finished the work.
        See Also:
        Constant Field Values
      • EVENT_BEGIN_FILE_PROCESSING

        static final int EVENT_BEGIN_FILE_PROCESSING
        The processing of a single file has been started.
        See Also:
        Constant Field Values
      • EVENT_END_FILE_PROCESSING

        static final int EVENT_END_FILE_PROCESSING
        The processing of a single file has been finished.
        See Also:
        Constant Field Values
      • EVENT_IGNORING_DIR

        static final int EVENT_IGNORING_DIR
        A source directory has been ignored (skipped.)
        See Also:
        Constant Field Values
      • EVENT_CREATED_EMPTY_DIR

        static final int EVENT_CREATED_EMPTY_DIR
        An empty directory was created due to the copyEmptyDirs setting.
        See Also:
        Constant Field Values
      • EVENT_WARNING

        static final int EVENT_WARNING
        A warning message has been received from a template or from the engine.
        See Also:
        Constant Field Values
      • EVENT_SOURCE_NOT_MODIFIED

        static final int EVENT_SOURCE_NOT_MODIFIED
        The processing of source was skipped because the output was generated after the last modification of the source file.
        See Also:
        Constant Field Values
    • Method Detail

      • notifyProgressEvent

        void notifyProgressEvent​(Engine engine,
                                 int event,
                                 java.io.File src,
                                 int pMode,
                                 java.lang.Throwable error,
                                 java.lang.Object param)
                          throws java.lang.Exception
        Method called be the engine to notify events.

        It is guaranteed that this method will not be called concurrently as far as the listener is added to a single Engine instance only.

        Parameters:
        engine - The engine instance where the event has occurred.
        event - The code of the event: an EVENT_... constant. As new event types can be introduced with new FMPP versions (even if it happens very seldom), a progress listener implementation should survive events that it does not understand. That is, it must not stop with an error, but it should silently ignore the event.
        src - Depending on event the source file or null.
        pMode - Depending on event the proccessing mode (Engine.PMODE_... constant) or Engine.PMODE_NONE. Note that new processing modes may be added as FMPP evolvers, so values that are not known be the progress listener should be handler nicely, and never cause error.
        error - The error, or null if there was no error.
        param - Extra information about the event. The class and meaning of object depends on the concrete event:
        • For EVENT_WARNING it is a String that describles the reason of warning.
        Throws:
        java.lang.Exception