KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > modules > Action


1 package org.apache.turbine.modules;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" and
29  * "Apache Turbine" must not be used to endorse or promote products
30  * derived from this software without prior written permission. For
31  * written permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * "Apache Turbine", nor may "Apache" appear in their name, without
35  * prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 import org.apache.turbine.RunData;
58
59 /**
60  * Generic Action class.
61  *
62  * @author <a HREF="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
63  * @version $Id: Action.java,v 1.2 2001/10/08 21:07:24 dlr Exp $
64  */
65 public abstract class Action
66     extends Module
67 {
68     /**
69      * A subclass must override this method to perform itself. The
70      * Action can also set the screen that is associated with RunData.
71      *
72      * @param data Turbine information.
73      * @exception Exception a generic exception.
74      */
75     public abstract void doPerform( RunData data )
76         throws Exception JavaDoc;
77
78     /**
79      * Subclasses can override this method to add additional
80      * functionality. This method is protected to force clients to
81      * use ActionLoader to perform an Action.
82      *
83      * @param data Turbine information.
84      * @exception Exception a generic exception.
85      */
86     protected void perform( RunData data )
87         throws Exception JavaDoc
88     {
89         doPerform( data );
90     }
91
92     /**
93      * Performs action modelled by your implementation by calling
94      * {@link #doPerform(RunData)}.
95      *
96      * @param data The data to use during execution.
97      * @see org.apache.turbine.modules.Module#execute(RunData)
98      */
99     public void execute(RunData data)
100         throws Exception JavaDoc
101     {
102         doPerform(data);
103     }
104 }
105
Popular Tags