com.sun.spot.client
Class DummySpotClientUI

java.lang.Object
  com.sun.spot.client.DummySpotClientUI

All Implemented Interfaces:

IUI

public class DummySpotClientUI
extends Object
implements IUI

DummySpotClientUI provides a null implementation of IUI convenient for using SpotClientCommands facilities when feedback is not required.

Constructor Summary

DummySpotClientUI()

DummySpotClientUI(boolean verbose)

Method Summary

void	diagnostic(String msg) Callback the SpotClient uses to provide diagnostic messages relating to the operation it's executing.
void	echoFromTarget(String msg) Callback the SpotClient uses to echo the output of the target SPOT.
void	info(String msg) Callback the SpotClient uses to provide information messages relating to the operation it's executing.
void	newProgress(int initialSteps, int totalSteps, String title) Callback the SpotClient uses to announce a new operation for which it will provide progress information.
void	progressEnd(String msg) Callback the SpotClient uses to announce the end of the current operation for which it is providing progress information.
void	progressUpdate(int stepsComplete, String msg) Callback the SpotClient uses to update progress for lengthy operations.
void	quit() Callback the SpotClient uses when it wants to exit.

Methods inherited from class java.lang.Object

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

Constructor Detail

DummySpotClientUI

public DummySpotClientUI()

DummySpotClientUI

public DummySpotClientUI(boolean verbose)

Method Detail

diagnostic

public void diagnostic(String msg)

Description copied from interface: IUI

Callback the SpotClient uses to provide diagnostic messages relating to the operation it's executing. These messages might or might not be displayed by the UI.

Specified by:

diagnostic in interface IUI

echoFromTarget

public void echoFromTarget(String msg)

Description copied from interface: IUI

Callback the SpotClient uses to echo the output of the target SPOT.

Specified by:

echoFromTarget in interface IUI

info

public void info(String msg)

Description copied from interface: IUI

Callback the SpotClient uses to provide information messages relating to the operation it's executing.

Specified by:

info in interface IUI

newProgress

public void newProgress(int initialSteps,
                        int totalSteps,
                        String title)

Description copied from interface: IUI

Callback the SpotClient uses to announce a new operation for which it will provide progress information. Because these operations are assumed to be serialised, there should only ever be one in progress at one time.

Specified by:

newProgress in interface IUI

Parameters:

initialSteps - The number of steps already completed (typically 0)

totalSteps - The total number of steps in the operation

title - Short description of the operation

progressEnd

public void progressEnd(String msg)

Description copied from interface: IUI

Callback the SpotClient uses to announce the end of the current operation for which it is providing progress information.

Specified by:

progressEnd in interface IUI

Parameters:

msg - Optional msg describing final completion

progressUpdate

public void progressUpdate(int stepsComplete,
                           String msg)

Description copied from interface: IUI

Callback the SpotClient uses to update progress for lengthy operations. Note that the totalSteps reported from #newProgress is only an estimate, and so it's possible that stepsComplete may be greater than the last totalSteps. In addition, this may be called at any time. If it's not called after IUI.newProgress(int, int, String) and before IUI.progressEnd(String) then it should be ignored.

Specified by:

progressUpdate in interface IUI

Parameters:

stepsComplete - Progress completed so far

msg - Optional description of the current subtask

quit

public void quit()

Description copied from interface: IUI

Callback the SpotClient uses when it wants to exit.

Specified by:

quit in interface IUI