org.eclipse.osgi.framework.console
Interface CommandInterpreter


public interface CommandInterpreter

A command interpreter is a shell that can interpret command lines. This object is passed as parameter when a CommandProvider is invoked.

This interface is not intended to be implemented by clients.

Since:
3.1

Method Summary
 java.lang.Object execute(java.lang.String cmd)
          Execute a command line as if it came from the end user and return the result.
 java.lang.String nextArgument()
          Get the next argument in the input.
 void print(java.lang.Object o)
          Prints an object to the outputstream
 void printBundleResource(Bundle bundle, java.lang.String resource)
          Prints the given bundle resource if it exists
 void printDictionary(java.util.Dictionary dic, java.lang.String title)
          Prints the given dictionary sorted by keys.
 void println()
          Prints an empty line to the outputstream
 void println(java.lang.Object o)
          Prints an object to the output medium (appended with newline character).
 void printStackTrace(java.lang.Throwable t)
          Print a stack trace including nested exceptions.
 

Method Detail

nextArgument

java.lang.String nextArgument()
Get the next argument in the input. E.g. if the commandline is hello world, the _hello method will get "world" as the first argument.


execute

java.lang.Object execute(java.lang.String cmd)
Execute a command line as if it came from the end user and return the result. Throws any exceptions generated by the command that executed.


print

void print(java.lang.Object o)
Prints an object to the outputstream

Parameters:
o - the object to be printed

println

void println()
Prints an empty line to the outputstream


println

void println(java.lang.Object o)
Prints an object to the output medium (appended with newline character).

If running on the target environment the user is prompted with '--more' if more than the configured number of lines have been printed without user prompt. That way the user of the program has control over the scrolling.

For this to work properly you should not embedded "\n" etc. into the string.

Parameters:
o - the object to be printed

printStackTrace

void printStackTrace(java.lang.Throwable t)
Print a stack trace including nested exceptions.

Parameters:
t - The offending exception

printDictionary

void printDictionary(java.util.Dictionary dic,
                     java.lang.String title)
Prints the given dictionary sorted by keys.

Parameters:
dic - the dictionary to print
title - the header to print above the key/value pairs

printBundleResource

void printBundleResource(Bundle bundle,
                         java.lang.String resource)
Prints the given bundle resource if it exists

Parameters:
bundle - the bundle containing the resource
resource - the resource to print