fmpp.progresslisteners
Class TerseConsoleProgressListener
java.lang.Object
fmpp.progresslisteners.TerseConsoleProgressListener
- All Implemented Interfaces:
- ProgressListener
public class TerseConsoleProgressListener
- extends java.lang.Object
- implements ProgressListener
Designed to show the progress on console screen in a
very terse way (Doom loader... :)).
Method Summary |
void |
notifyProgressEvent(Engine engine,
int event,
java.io.File src,
int pMode,
java.lang.Throwable error,
java.lang.Object param)
Method called be the engine to notify events. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TerseConsoleProgressListener
public TerseConsoleProgressListener()
- Output will be printed to the stdout.
TerseConsoleProgressListener
public TerseConsoleProgressListener(java.io.OutputStream out)
TerseConsoleProgressListener
public TerseConsoleProgressListener(java.io.PrintWriter out)
notifyProgressEvent
public void notifyProgressEvent(Engine engine,
int event,
java.io.File src,
int pMode,
java.lang.Throwable error,
java.lang.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 interface ProgressListener
- Parameters:
engine
- The engine instance where the event has occured.event
- The code of the envent: 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.