Package fmpp.progresslisteners
Class TerseConsoleProgressListener
java.lang.Object
fmpp.progresslisteners.TerseConsoleProgressListener
- All Implemented Interfaces:
ProgressListener
Designed to show the progress on console screen in a
very terse way (prints a symbol for each processed file).
-
Field Summary
Fields inherited from interface fmpp.ProgressListener
EVENT_BEGIN_FILE_PROCESSING, EVENT_BEGIN_PROCESSING_SESSION, EVENT_CREATED_EMPTY_DIR, EVENT_END_FILE_PROCESSING, EVENT_END_PROCESSING_SESSION, EVENT_IGNORING_DIR, EVENT_SOURCE_NOT_MODIFIED, EVENT_WARNING
-
Constructor Summary
ConstructorsConstructorDescriptionOutput will be printed to the stdout. -
Method Summary
Modifier and TypeMethodDescriptionvoid
notifyProgressEvent
(Engine engine, int event, File src, int pMode, Throwable error, Object param) Method called be the engine to notify events.
-
Constructor Details
-
TerseConsoleProgressListener
public TerseConsoleProgressListener()Output will be printed to the stdout. -
TerseConsoleProgressListener
-
TerseConsoleProgressListener
-
-
Method Details
-
notifyProgressEvent
public void notifyProgressEvent(Engine engine, int event, File src, int pMode, Throwable error, Object param) Description copied from interface:ProgressListener
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.- Specified by:
notifyProgressEvent
in interfaceProgressListener
- Parameters:
engine
- The engine instance where the event has occurred.event
- The code of the event: anEVENT_...
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 onevent
the source file or null.pMode
- Depending onevent
the proccessing mode (Engine.PMODE_...
constant) orEngine.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 aString
that describles the reason of warning.
- For
-