SunSPOT host API V3.0


com.sun.spot.client.command
Class GetSystemPropertiesCommand

java.lang.Object
  extended by com.sun.spot.client.command.AbstractClientCommand
      extended by com.sun.spot.client.command.GetSystemPropertiesCommand
All Implemented Interfaces:
ISpotClientCommand

public class GetSystemPropertiesCommand
extends AbstractClientCommand

GetSystemPropertiesCommand: answer the user-defined system properties available at run time on the SPOT.


Field Summary
static String NAME
           
 
Fields inherited from interface com.sun.spot.client.command.ISpotClientCommand
SIGNATURE_BOOLEAN, SIGNATURE_INT, SIGNATURE_LONG, SIGNATURE_NOTHING, SIGNATURE_OPTIONAL_SECOND_STRING, SIGNATURE_OPTIONAL_STRING, SIGNATURE_STRING, SIGNATURE_THREE_STRINGS, SIGNATURE_TWO_STRINGS
 
Constructor Summary
GetSystemPropertiesCommand()
           
 
Method Summary
 Object execute(ISpotClientCommandHelper helper)
          If the receiver's ISpotClientCommand.getSignature() is ISpotClientCommand.SIGNATURE_NOTHING then execute the command, otherwise throw an IllegalStateException
 String getName()
           
 int getSignature()
          Answer the signature for execution of the command (see various constants SIGNATURE_...)
 String getUsage()
           
 
Methods inherited from class com.sun.spot.client.command.AbstractClientCommand
assertThat, execute, execute, execute, execute, execute, execute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final String NAME
See Also:
Constant Field Values
Constructor Detail

GetSystemPropertiesCommand

public GetSystemPropertiesCommand()
Method Detail

getSignature

public int getSignature()
Description copied from interface: ISpotClientCommand
Answer the signature for execution of the command (see various constants SIGNATURE_...)

Returns:
the signature identifier

execute

public Object execute(ISpotClientCommandHelper helper)
               throws SpotClientException,
                      IOException
Description copied from interface: ISpotClientCommand
If the receiver's ISpotClientCommand.getSignature() is ISpotClientCommand.SIGNATURE_NOTHING then execute the command, otherwise throw an IllegalStateException

Specified by:
execute in interface ISpotClientCommand
Overrides:
execute in class AbstractClientCommand
Parameters:
helper - infrastructure-supplied source of command helper operations
Returns:
a Properties containing the user-defined system properties available at run time on the SPOT.
Throws:
SpotClientException
IOException

getName

public String getName()
Returns:
the command name

getUsage

public String getUsage()
Returns:
a description of how to use the command

SunSPOT host API V3.0


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