org.apache.struts.config
Class ForwardConfig

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

public class ForwardConfig
extends java.lang.Object
implements java.io.Serializable

A JavaBean representing the configuration information of a <forward> element from a Struts configuration file.

Since:
Struts 1.1
Version:
$Rev: 55980 $ $Date: 2004-10-29 16:34:55 +0100 (Fri, 29 Oct 2004) $
See Also:
Serialized Form

Field Summary
protected  boolean configured
          Has this component been completely configured?
protected  boolean contextRelative
          Deprecated. Use module property instead; will be removed in a release following 1.2.0.
protected  java.lang.String module
          The prefix of the module to which this ForwardConfig entry points, which must start with a slash ("/") character.
protected  java.lang.String name
          The unique identifier of this forward, which is used to reference it in Action classes.
protected  java.lang.String path
          The URL to which this ForwardConfig entry points, which must start with a slash ("/") character.
protected  boolean redirect
          Should a redirect be used to transfer control to the specified path?
 
Constructor Summary
ForwardConfig()
          Construct a new instance with default values.
ForwardConfig(java.lang.String name, java.lang.String path, boolean redirect)
          Construct a new instance with the specified values.
ForwardConfig(java.lang.String name, java.lang.String path, boolean redirect, boolean contextRelative)
          Deprecated. Use module rather than contextRelative
ForwardConfig(java.lang.String name, java.lang.String path, boolean redirect, java.lang.String module)
          Construct a new instance with the specified values.
 
Method Summary
 void freeze()
          Freeze the configuration of this component.
 boolean getContextRelative()
          Deprecated. Use module property instead; will be removed in a release following 1.2.0.
 java.lang.String getModule()
           
 java.lang.String getName()
           
 java.lang.String getPath()
           
 boolean getRedirect()
           
 void setContextRelative(boolean contextRelative)
          Deprecated. Use module property instead; will be removed in a release following 1.2.0.
 void setModule(java.lang.String module)
           
 void setName(java.lang.String name)
           
 void setPath(java.lang.String path)
           
 void setRedirect(boolean redirect)
           
 java.lang.String toString()
          Return a String representation of this object.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

configured

protected boolean configured
Has this component been completely configured?

contextRelative

protected boolean contextRelative
Deprecated. Use module property instead; will be removed in a release following 1.2.0.

Should the value of the path property be considered context-relative if it starts with a slash (and therefore not prefixed with the module prefix?

name

protected java.lang.String name
The unique identifier of this forward, which is used to reference it in Action classes.

path

protected java.lang.String path

The URL to which this ForwardConfig entry points, which must start with a slash ("/") character. It is interpreted according to the following rules:


module

protected java.lang.String module

The prefix of the module to which this ForwardConfig entry points, which must start with a slash ("/") character.

Usage note: If a forward config is used in a hyperlink, and a module is specified, the path must lead to another action and not directly to a page. This is in keeping with rule that in a modular application all links must be to an action rather than a page.


redirect

protected boolean redirect
Should a redirect be used to transfer control to the specified path?
Constructor Detail

ForwardConfig

public ForwardConfig()
Construct a new instance with default values.

ForwardConfig

public ForwardConfig(java.lang.String name,
                     java.lang.String path,
                     boolean redirect)
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?

ForwardConfig

public ForwardConfig(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 forward
path - Path to which control should be forwarded or redirected
redirect - Should we do a redirect?
contextRelative - Is this path context relative?

ForwardConfig

public ForwardConfig(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
Method Detail

getContextRelative

public boolean getContextRelative()
Deprecated. Use module property instead; will be removed in a release following 1.2.0.


setContextRelative

public void setContextRelative(boolean contextRelative)
Deprecated. Use module property instead; will be removed in a release following 1.2.0.


getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getPath

public java.lang.String getPath()

setPath

public void setPath(java.lang.String path)

getModule

public java.lang.String getModule()

setModule

public void setModule(java.lang.String module)

getRedirect

public boolean getRedirect()

setRedirect

public void setRedirect(boolean redirect)

freeze

public void freeze()
Freeze the configuration of this component.

toString

public java.lang.String toString()
Return a String representation of this object.
Overrides:
toString in class java.lang.Object


Copyright 2000-2006 - The Apache Software Foundation