1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.chain.generic;
18
19
20 import org.apache.commons.chain.Command;
21 import org.apache.commons.chain.Context;
22
23
24 /**
25 * <p>Remove any context attribute stored under the <code>fromKey</code>.</p>
26 *
27 * @author Craig R. McClanahan
28 * @version $Revision: 480477 $ $Date: 2006-11-29 08:34:52 +0000 (Wed, 29 Nov 2006) $
29 */
30
31 public class RemoveCommand implements Command {
32
33
34 // -------------------------------------------------------------- Properties
35
36
37 private String fromKey = null;
38
39
40 /**
41 * <p>Return the context attribute key for the attribute.</p>
42 * @return The context attribute key.
43 */
44 public String getFromKey() {
45
46 return (this.fromKey);
47
48 }
49
50
51 /**
52 * <p>Set the context attribute key for the attribute.</p>
53 *
54 * @param fromKey The new key
55 */
56 public void setFromKey(String fromKey) {
57
58 this.fromKey = fromKey;
59
60 }
61
62
63 // ---------------------------------------------------------- Filter Methods
64
65
66 /**
67 * <p>Copy the specified source attribute to the specified destination
68 * attribute.</p>
69 *
70 * @param context {@link Context} in which we are operating
71 *
72 * @return <code>false</code> so that processing will continue
73 * @throws Exception if and error occurs.
74 */
75 public boolean execute(Context context) throws Exception {
76
77 context.remove(getFromKey());
78 return (false);
79
80 }
81
82
83 }