org.apache.struts.action
Class ActionForward

java.lang.Object
  |
  +--org.apache.struts.config.ForwardConfig
        |
        +--org.apache.struts.action.ActionForward
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ActionRedirect, ForwardingActionForward, RedirectingActionForward

public class ActionForward
extends ForwardConfig

An ActionForward represents a destination to which the controller, RequestProcessor, might be directed to perform a RequestDispatcher.forward or HttpServletResponse.sendRedirect to, as a result of processing activities of an Action class. Instances of this class may be created dynamically as necessary, or configured in association with an ActionMapping instance for named lookup of potentially multiple destinations for a particular mapping instance.

An ActionForward has the following minimal set of properties. Additional properties can be provided as needed by subclassses.

Since Struts 1.1 this class extends ForwardConfig and inherits the contextRelative property.

NOTE - This class would have been deprecated and replaced by org.apache.struts.config.ForwardConfig except for the fact that it is part of the public API that existing applications are using.

Version:
$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
See Also:
Serialized Form

Fields inherited from class org.apache.struts.config.ForwardConfig
configured, contextRelative, module, name, path, redirect
 
Constructor Summary
ActionForward()
          Construct a new instance with default values.
ActionForward(ActionForward copyMe)
          Construct a new instance based on the values of another ActionForward.
ActionForward(java.lang.String path)
          Construct a new instance with the specified path.
ActionForward(java.lang.String path, boolean redirect)
          Construct a new instance with the specified path and redirect flag.
ActionForward(java.lang.String name, java.lang.String path, boolean redirect)
          Construct a new instance with the specified name, path and redirect flag.
ActionForward(java.lang.String name, java.lang.String path, boolean redirect, boolean contextRelative)
          Deprecated. Use module rather than contextRelative
ActionForward(java.lang.String name, java.lang.String path, boolean redirect, java.lang.String module)
          Construct a new instance with the specified values.
 
Methods inherited from class org.apache.struts.config.ForwardConfig
freeze, getContextRelative, getModule, getName, getPath, getRedirect, setContextRelative, setModule, setName, setPath, setRedirect, toString
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Constructor Detail

ActionForward

public ActionForward()

Construct a new instance with default values.


ActionForward

public ActionForward(java.lang.String path)

Construct a new instance with the specified path.

Parameters:
path - Path for this instance

ActionForward

public ActionForward(java.lang.String path,
                     boolean redirect)

Construct a new instance with the specified path and redirect flag.

Parameters:
path - Path for this instance
redirect - Redirect flag for this instance

ActionForward

public ActionForward(java.lang.String name,
                     java.lang.String path,
                     boolean redirect)

Construct a new instance with the specified name, path and redirect flag.

Parameters:
name - Name of this instance
path - Path for this instance
redirect - Redirect flag for this instance

ActionForward

public ActionForward(java.lang.String name,
                     java.lang.String path,
                     boolean redirect,
                     boolean contextRelative)
Deprecated. Use module rather than contextRelative

Construct a new instance with the specified values.

Parameters:
name - Name of this instance
path - Path for this instance
redirect - Redirect flag for this instance
contextRelative - Context relative flag for this instance

ActionForward

public ActionForward(java.lang.String name,
                     java.lang.String path,
                     boolean redirect,
                     java.lang.String module)
Construct a new instance with the specified values.
Parameters:
name - Name of this forward
path - Path to which control should be forwarded or redirected
redirect - Should we do a redirect?
module - Module prefix, if any

ActionForward

public ActionForward(ActionForward copyMe)

Construct a new instance based on the values of another ActionForward.

Parameters:
copyMe - An ActionForward instance to copy
Since:
Struts 1.2.1


Copyright 2000-2006 - The Apache Software Foundation