All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.core.Route 

java.lang.Object
   |
   +----com.sun.wizards.core.Route
public class Route
extends Object
implements Serializable
Route is an object that has information that guides requests from the server to the client or from the client to the server.

This object facilitates communication between the client and the server. On the server side, each WizardState object has a unique Route object. On the client side, each panel within the wizard client panel tree has a unique Route object. The Route objects simply route messages to the correct object.

Variable Index

o clientRoute
Route information specific to the client.
o serverRoute
Route information specific to the server.

Constructor Index

o Route()
Creates a route with no server or client entries.

Method Index

o addClientRoute(String)
Add an element to the client route.
o addServerRoute(String)
Add an element to the server route.
o copy()
Create a copy of this Route object.
o equals(Object)
Compares two routes for equality.
o getChildClientRoute(String)
Return a route representing a path to a child of this route object.
o getChildServerRoute(String)
Return a route representing a path to a child of this route object.
o getClientServerRoute()
Returns a route to the parent of the client object referenced by this route.
o getNextClientRoute()
Get the next client id.
o getNextServerRoute()
Get the next server id.
o getParentServerRoute()
Returns a route to the parent of the server object referenced by this route.
o isClientRouteComplete()
Returns the completion status of the client route.
o isServerRouteComplete()
Returns the completion status of the server route.
o toString()
Convert this route to a string.

Variables

o serverRoute 
 protected Stack serverRoute
Route information specific to the server.

o clientRoute 
 protected Stack clientRoute
Route information specific to the client.

Constructors

o Route 
 public Route()
Creates a route with no server or client entries. This accomplishes a route to the root object.

Methods

o equals 
 public boolean equals(Object obj)
Compares two routes for equality.

Parameters:
obj - The route object to compare to.
Returns:
true if the routes are equal; false otherwise.
Overrides:
equals in class Object
o copy 
 public Route copy()
Create a copy of this Route object.

Returns:
The copy of this route object.
o addServerRoute 
 public void addServerRoute(String newServerElement)
Add an element to the server route.

Parameters:
newServerElement - The element to be added to the server route.
o getChildServerRoute 
 public Route getChildServerRoute(String newServerChild)
Return a route representing a path to a child of this route object.

Parameters:
newServerChild - The name of the child.
o getParentServerRoute 
 public Route getParentServerRoute()
Returns a route to the parent of the server object referenced by this route.

o getChildClientRoute 
 public Route getChildClientRoute(String newClientChild)
Return a route representing a path to a child of this route object.

Parameters:
newClientChild - The child.
Returns:
The route to the specified child.
o getClientServerRoute 
 public Route getClientServerRoute()
Returns a route to the parent of the client object referenced by this route.

o addClientRoute 
 public void addClientRoute(String newClientElement)
Add an element to the client route.

Parameters:
newClientElement - The element to be added to the client route.
o getNextServerRoute 
 public String getNextServerRoute()
Get the next server id.

Returns:
The requested server id.
o getNextClientRoute 
 public String getNextClientRoute()
Get the next client id.

Returns:
The requested client id.
o isServerRouteComplete 
 public boolean isServerRouteComplete()
Returns the completion status of the server route.

Returns:
true if the server route is complete, false otherwise.
o isClientRouteComplete 
 public boolean isClientRouteComplete()
Returns the completion status of the client route.

Returns:
true if the client route is complete, false otherwise.
o toString 
 public String toString()
Convert this route to a string.

Overrides:
toString in class Object 
All Packages  Class Hierarchy  This Package  Previous  Next  Index