View Javadoc

1   package org.apache.turbine.modules;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.turbine.util.RunData;
23  
24  /***
25   * Generic Action class.
26   *
27   * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
28   * @version $Id: Action.java 534527 2007-05-02 16:10:59Z tv $
29   */
30  public abstract class Action extends Assembler
31  {
32      /***
33       * A subclass must override this method to perform itself.  The
34       * Action can also set the screen that is associated with RunData.
35       *
36       * @param data Turbine information.
37       * @exception Exception a generic exception.
38       */
39      public abstract void doPerform(RunData data) throws Exception;
40  
41      /***
42       * Subclasses can override this method to add additional
43       * functionality.  This method is protected to force clients to
44       * use ActionLoader to perform an Action.
45       *
46       * @param data Turbine information.
47       * @exception Exception a generic exception.
48       */
49      protected void perform(RunData data) throws Exception
50      {
51          doPerform(data);
52      }
53  }