org.pfsw.tools.cda.darc
Interface IRemoteControl

All Known Implementing Classes:
DARCConnection

public interface IRemoteControl

Specifies the methods that are available for remote control of the Class Dependency Analyzer.

Version:
1.0
Author:
M.Duchrow

Field Summary
static java.lang.String DEFAULT_HOST
          The default host name for remote control ("localhost").
static java.lang.String DEFAULT_PORT
          The default port for remote control (4242).
 
Method Summary
 IParameterMap execute(CommandName command, IParameterMap parameters)
          Executes a command with the given parameters and returns a map with the result of the execution.
 

Field Detail

DEFAULT_HOST

static final java.lang.String DEFAULT_HOST
The default host name for remote control ("localhost").

See Also:
Constant Field Values

DEFAULT_PORT

static final java.lang.String DEFAULT_PORT
The default port for remote control (4242).

See Also:
Constant Field Values
Method Detail

execute

IParameterMap execute(CommandName command,
                      IParameterMap parameters)
Executes a command with the given parameters and returns a map with the result of the execution.

The names and values of the parameters are defined in the command reference. Any parameters that are not recognized for a particular command will be ignored.

Parameters:
command - The name of the command to be executed (must not be null).
parameters - The parameter for the command (must not be null).
Returns:
A map with the result (never null).