Interface IDTFJContext

All Superinterfaces:

IContext

All Known Subinterfaces:

ICombinedContext

All Known Implementing Classes:

CombinedContext, DTFJContext, EmptyDTFJContext

public interface IDTFJContext
extends IContext

Method Summary

Modifier and Type	Method	Description
ImageAddressSpace	getAddressSpace()	The address space for this context.
DTFJImageBean	getImage()	A simple Java bean which allows access to the data on DTFJ image interface.
int	getMajorVersion()	The major version of the DTFJ API for this context.
int	getMinorVersion()	The minor version of the DTFJ API for this context.
ImageProcess	getProcess()	The process for this context.
JavaRuntime	getRuntime()	The Java runtime for this context.
boolean	hasPropertyBeenSet(String name)	Used to determine if a property has been set in the context property bag, and that the value of that property is TRUE

Methods declared in interface IContext

execute, execute, execute, getCommands, getLastCommandException, getLastExecutedCommand, getPluginClassloader, getProperties, isCommandRecognised, refresh

Modifier and Type	Method	Description
void	execute(CommandParser command, PrintStream out)	Execute the entered command line with the output sent to the supplied print stream.
void	execute(String cmdline, PrintStream out)	Execute the entered command line with the output sent to the supplied print stream.
void	execute(String cmdline, String[] arguments, PrintStream out)	Execute the entered command line with the output sent to the supplied print stream.
List<ICommand>	getCommands()	Returns a list of commands which are available for this context
Exception	getLastCommandException()	Provides access to any uncaught exceptions thrown when the last command was executed.
ICommand	getLastExecutedCommand()	The last command which was successfully executed by the context.
PluginLoader	getPluginClassloader()	Gets the classloader which has been used to add plugins.
Properties	getProperties()	A set of defined properties.
boolean	isCommandRecognised(String command)	Allows to check if the given command will be executed (i.e. if there is a command that will accept the string) without actually executing it, avoiding error messages etc.
void	refresh()	Refreshes the context, this will perform actions such as rescanning the plugin path or other initialization tasks.

Method Details

getMajorVersion

int getMajorVersion()

The major version of the DTFJ API for this context.

Returns:

major version number

getMinorVersion

int getMinorVersion()

The minor version of the DTFJ API for this context.

Returns:

minor version number

getAddressSpace

ImageAddressSpace getAddressSpace()

The address space for this context. This may or may not contain any processes.

Returns:

the image address space

getProcess

ImageProcess getProcess()

The process for this context. A process may or may not contain a Java runtime.

Returns:

getRuntime

JavaRuntime getRuntime()

The Java runtime for this context.

Returns:

the runtime or null if there is no runtime available

getImage

DTFJImageBean getImage()

A simple Java bean which allows access to the data on DTFJ image interface. This removes the requirement to provide a command/plugin with a direct reference to the Image.

Returns:

the bean

hasPropertyBeenSet

boolean hasPropertyBeenSet(String name)

Used to determine if a property has been set in the context property bag, and that the value of that property is TRUE

Parameters:

name - property name to check

Returns:

true if the property exists and Boolean.parseValue() returns true