org.apache.commons.chain.generic
Class RemoveCommand

java.lang.Object
  org.apache.commons.chain.generic.RemoveCommand

All Implemented Interfaces:

Command

public class RemoveCommand

extends Object

implements Command

Remove any context attribute stored under the fromKey.

Version:

$Revision: 410386 $ $Date: 2006-05-30 22:48:31 +0100 (Tue, 30 May 2006) $

Author:

Craig R. McClanahan

Field Summary

Fields inherited from interface org.apache.commons.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

RemoveCommand()

Method Summary

boolean	execute(Context context) Copy the specified source attribute to the specified destination attribute.
String	getFromKey() Return the context attribute key for the attribute.
void	setFromKey(String fromKey) Set the context attribute key for the attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveCommand

public RemoveCommand()

Method Detail

getFromKey

public String getFromKey()

Return the context attribute key for the attribute.

Returns:

The context attribute key.

setFromKey

public void setFromKey(String fromKey)

Set the context attribute key for the attribute.

Parameters:

fromKey - The new key

execute

public boolean execute(Context context)
                throws Exception

Copy the specified source attribute to the specified destination attribute.

Specified by:

execute in interface Command

Parameters:

context - Context in which we are operating

Returns:

false so that processing will continue

Throws:

Exception - if and error occurs.