us.zuercher.gpx2map.gui
Class GuiProgressMeterFactory

java.lang.Object
  us.zuercher.gpx2map.gui.GuiProgressMeterFactory

All Implemented Interfaces:

ProgressMeterFactory

 class GuiProgressMeterFactory
extends Object
implements ProgressMeterFactory

GuiProgressMeterFactory is a ProgressMeterFactory for GuiProgressMeter objects. GuiProgressMeterFactory does not return a new instance of GuiProgressMeter each time newProgressMeter(String) is called. Instead, the same meter is returned repeatedly until close() is called.

If you require multiple separate GuiProgressMeter objects to exist at the same time, use multiple factories.

Author:

Stephan Zuercher

Field Summary

private GuiProgressMeter	meter This factory's current progress meter.
private JFrame	root The application's root frame.

Constructor Summary

GuiProgressMeterFactory(JFrame root)
Constructs a new GuiProgressMeterFactory with the given application root frame.

Method Summary

void	close() Closes the current GuiProgressMeter and clears its reference.
MessageSink	getMessageSink() Returns the current progress meter as a {link MessageSink}.
ProgressMeter	newProgressMeter(String progressMeterName) Returns this GuiProgressMeterFactory's current GuiProgressMeter with the dialog name set to the given value.

Methods inherited from class java.lang.Object

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

Field Detail

root

private final JFrame root

The application's root frame. Passed to the GuiProgressMeter.

meter

private GuiProgressMeter meter

This factory's current progress meter.

Constructor Detail

GuiProgressMeterFactory

GuiProgressMeterFactory(JFrame root)

Constructs a new GuiProgressMeterFactory with the given application root frame.

Parameters:

root - application root frame

Method Detail

newProgressMeter

public ProgressMeter newProgressMeter(String progressMeterName)

Returns this GuiProgressMeterFactory's current GuiProgressMeter with the dialog name set to the given value. If not GuiProgressMeter currently exists, one is constructed.

Specified by:

newProgressMeter in interface ProgressMeterFactory

Parameters:

progressMeterName - the progress meter name.

Returns:

a GuiProgressMeter, which may or may not be newly consturcted

See Also:

close()

getMessageSink

public MessageSink getMessageSink()

Returns the current progress meter as a {link MessageSink}. If newProgressMeter(String) has never been called for this ProgressMeterFactory, returns null.

Returns:

a GuiProgressMeter as a MessageSink, or null if the progress meter hasn't been constructed yet.

See Also:

close()

close

public void close()

Closes the current GuiProgressMeter and clears its reference. After calling this method, calling newProgressMeter(String) will construct a new GuiProgressMeter and getMessageSink() behaves as if newProgressMeter(String) has never been called.

Specified by:

close in interface ProgressMeterFactory