SunSPOT host API V3.0


com.sun.spot.client
Interface IUI

All Known Implementing Classes:
DummySpotClientUI, RemoteLogger, SerialPortLogger, SpotClientCommandLineUI

public interface IUI

Interface that must be implemented by the Spot Client UI component. Provides a means for Spot Client to feedback information about operations on the SPOT. If you are developing on top of Spot Client but do not have a user interface, then use a DummySpotClientUI.
See the SPOT Developer's Guide for more details.


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.
 

Method Detail

info

void info(String msg)
Callback the SpotClient uses to provide information messages relating to the operation it's executing.

Parameters:
msg -

echoFromTarget

void echoFromTarget(String msg)
Callback the SpotClient uses to echo the output of the target SPOT.

Parameters:
msg -

newProgress

void newProgress(int initialSteps,
                 int totalSteps,
                 String title)
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.

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

progressUpdate

void progressUpdate(int stepsComplete,
                    String msg)
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 newProgress(int, int, String) and before progressEnd(String) then it should be ignored.

Parameters:
stepsComplete - Progress completed so far
msg - Optional description of the current subtask

progressEnd

void progressEnd(String msg)
Callback the SpotClient uses to announce the end of the current operation for which it is providing progress information.

Parameters:
msg - Optional msg describing final completion

diagnostic

void diagnostic(String msg)
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.

Parameters:
msg -

quit

void quit()
Callback the SpotClient uses when it wants to exit.


SunSPOT host API V3.0


Copyright © 2006, 2007 Sun Microsystems, Inc. All Rights Reserved.