Package org.apache.commons.chain.generic

Class RemoveCommand<C extends Context>

java.lang.Object

org.apache.commons.chain.generic.RemoveCommand<C>

Type Parameters:

C - Type of the context associated with this command

All Implemented Interfaces:

Command<C>

public class RemoveCommand<C extends Context>
extends Object
implements Command<C>

Remove any context attribute stored under the fromKey.

Version:

$Revision$ $Date$

Author:

Craig R. McClanahan

Field Summary

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

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

Constructors

Constructor	Description
RemoveCommand()	The Default-Constructor for this class.

Method Summary

Modifier and Type	Method	Description
boolean	execute(C 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 Details

RemoveCommand

public RemoveCommand()

The Default-Constructor for this class.

Method Details

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(C context)
                throws Exception

Copy the specified source attribute to the specified destination attribute.

Specified by:

execute in interface Command<C extends Context>

Parameters:

context - Context in which we are operating

Returns:

false so that processing will continue

Throws:

Exception - if and error occurs.