com.oroad.stxx.action
Class ActionForward

java.lang.Object
  extended byorg.apache.struts.config.ForwardConfig
      extended byorg.apache.struts.action.ActionForward
          extended bycom.oroad.stxx.action.ActionForward
All Implemented Interfaces:
java.io.Serializable

public class ActionForward
extends org.apache.struts.action.ActionForward

Holds the information in a Struts forward element. Used with Struts 1.0.

Author:
Jeff Pennal, Don Brown
See Also:
Serialized Form

Field Summary
protected  java.lang.String root
          The XML root node of this forward.
protected  java.lang.String transform
          The name of the transform tag
protected  ActionTransforms transforms
          The set of ActionTransform objects associated with this mapping.
 
Fields inherited from class org.apache.struts.config.ForwardConfig
configured, contextRelative, name, path, redirect
 
Constructor Summary
ActionForward()
          Construct a new instance with default values.
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.
 
Method Summary
 void addTransform(ActionTransform transform)
          Add a new ActionTransform associated with this mapping.
 ActionTransform findTransform(java.lang.String name)
          Return the ActionTransform with the specified name, if any; otherwise return null.
 java.lang.String[] findTransforms()
          Return the logical names of all locally defined transforms for this mapping.
 java.lang.String getName()
          Gets the name of the forward
 java.lang.String getPath()
          Gets the path attribute
 boolean getRedirect()
          Gets the redirect attribute
 java.lang.String getRoot()
          Deprecated. This shouldn't be used any longer
 java.lang.String getTransform()
          Return the transform path for this mapping.
 boolean hasTransforms()
          Returns true or false depending on if the ActionForward has a transform tag under it or not
 void removeTransform(ActionTransform transform)
          Remove a ActionTransform associated with this mapping.
 void setName(java.lang.String name)
          Sets the name of the forward
 void setPath(java.lang.String path)
          Sets the path attribute
 void setRedirect(boolean redirect)
          Sets the redirect attribute
 void setRoot(java.lang.String root)
          Deprecated. This shouldn't be used any longer
 void setTransform(java.lang.String transform)
          Set the transform path for this mapping.
 java.lang.String toString()
          Returns a String representation of the forward
 
Methods inherited from class org.apache.struts.config.ForwardConfig
freeze, getContextRelative, setContextRelative
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

transform

protected java.lang.String transform
The name of the transform tag


transforms

protected ActionTransforms transforms
The set of ActionTransform objects associated with this mapping.


root

protected java.lang.String root
The XML root node of this forward.

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
Method Detail

hasTransforms

public boolean hasTransforms()
Returns true or false depending on if the ActionForward has a transform tag under it or not

Returns:
True if transforms exist

getTransform

public java.lang.String getTransform()
Return the transform path for this mapping.

Returns:
The transform value

setTransform

public void setTransform(java.lang.String transform)
Set the transform path for this mapping.

Parameters:
transform - The transform path for this mapping

addTransform

public void addTransform(ActionTransform transform)
Add a new ActionTransform associated with this mapping.

Parameters:
transform - The ActionTransform to be added

findTransforms

public java.lang.String[] findTransforms()
Return the logical names of all locally defined transforms for this mapping. If there are no such transforms, a zero-length array is returned.

Returns:
A String array of transform names

findTransform

public ActionTransform findTransform(java.lang.String name)
Return the ActionTransform with the specified name, if any; otherwise return null. If there is no locally defined transforming for the specified name, but a global transforms collection has been associated with this mapping, the global collection will also be searched before returning.

Parameters:
name - Name of the transform entry to be returned
Returns:
The found Transform

removeTransform

public void removeTransform(ActionTransform transform)
Remove a ActionTransform associated with this mapping.

Parameters:
transform - The ActionTransform to be removed

getName

public java.lang.String getName()
Gets the name of the forward

Returns:
The name value

setName

public void setName(java.lang.String name)
Sets the name of the forward

Parameters:
name - The new name value

getRoot

public java.lang.String getRoot()
Deprecated. This shouldn't be used any longer

Gets the root attribute

Returns:
The root value

setRoot

public void setRoot(java.lang.String root)
Deprecated. This shouldn't be used any longer

Sets the root attribute

Parameters:
root - The new root value

getPath

public java.lang.String getPath()
Gets the path attribute

Returns:
The path value

setPath

public void setPath(java.lang.String path)
Sets the path attribute

Parameters:
path - The new path value

getRedirect

public boolean getRedirect()
Gets the redirect attribute

Returns:
The redirect value

setRedirect

public void setRedirect(boolean redirect)
Sets the redirect attribute

Parameters:
redirect - The new redirect value

toString

public java.lang.String toString()
Returns a String representation of the forward

Returns:
A debugging String