org.writersforge.catalan.process.commands
Class CommandContext

java.lang.Object
  org.writersforge.catalan.process.commands.CommandContext

public class CommandContext

extends java.lang.Object

Encapsulates the set of parameters which should be passed to the ICommand.run() method.

Author:

jsheets

Constructor Summary

CommandContext(IWorkProperties runtimeProps, IWorkspace workspace)
Creates a new instance of CommandContext.

CommandContext(IWorkProperties runtimeProps, IWorkspace workspace, java.util.List activeNodes)
Creates a new instance of CommandContext with an active nodes set.

Method Summary

java.util.List	getActiveNodes() Retrieves the active nodes the command should operate on.
IWorkProperties	getRuntimeProps() Retrieves the runtime properties that the command should use.
IWorkspace	getWorkspace() Retrieves the workspace that the command should use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandContext

public CommandContext(IWorkProperties runtimeProps,
                      IWorkspace workspace)

Creates a new instance of CommandContext.

Parameters:

runtimeProps - command properties

workspace - command workspace

CommandContext

public CommandContext(IWorkProperties runtimeProps,
                      IWorkspace workspace,
                      java.util.List activeNodes)

Creates a new instance of CommandContext with an active nodes set.

Parameters:

runtimeProps - command properties

workspace - command workspace

activeNodes - set of active queue nodes

Method Detail

getRuntimeProps

public final IWorkProperties getRuntimeProps()

Retrieves the runtime properties that the command should use.

Returns:

command properties

getWorkspace

public final IWorkspace getWorkspace()

Retrieves the workspace that the command should use.

Returns:

command workspace

getActiveNodes

public final java.util.List getActiveNodes()

Retrieves the active nodes the command should operate on.

Returns:

active nodes for command