You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by ce...@apache.org on 2003/02/27 20:21:09 UTC
cvs commit: jakarta-struts/src/share/org/apache/struts/tiles UrlController.java UntyppedAttribute.java TilesUtilStrutsModulesImpl.java TilesUtilStrutsImpl.java TilesUtilImpl.java TilesUtil.java TilesRequestProcessor.java TilesPlugin.java TilesException.java PathAttribute.java NoSuchDefinitionException.java FactoryNotFoundException.java DefinitionsFactoryException.java DefinitionsFactoryConfig.java ControllerSupport.java ComponentContext.java ActionController.java ActionComponentServlet.java
cedric 2003/02/27 11:21:09
Modified: src/share/org/apache/struts/tiles UrlController.java
UntyppedAttribute.java
TilesUtilStrutsModulesImpl.java
TilesUtilStrutsImpl.java TilesUtilImpl.java
TilesUtil.java TilesRequestProcessor.java
TilesPlugin.java TilesException.java
PathAttribute.java NoSuchDefinitionException.java
FactoryNotFoundException.java
DefinitionsFactoryException.java
DefinitionsFactoryConfig.java
ControllerSupport.java ComponentContext.java
ActionController.java ActionComponentServlet.java
Log:
Documentation corrections and updates.
No code change.
Patches from Yann Cebron
Revision Changes Path
1.3 +10 -9 jakarta-struts/src/share/org/apache/struts/tiles/UrlController.java
Index: UrlController.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/UrlController.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- UrlController.java 5 Nov 2002 14:08:56 -0000 1.2
+++ UrlController.java 27 Feb 2003 19:20:50 -0000 1.3
@@ -71,18 +71,19 @@
/**
- * Tiles controller including a local URL
+ * Tiles controller including a local URL.
* @author Cedric Dumoulin
*/
public class UrlController implements Controller
{
- /** Url associated to this controller */
+ /** Url associated with this controller. */
protected String url;
/**
* Constructor.
+ * @param url URL.
*/
public UrlController( String url )
{
@@ -91,12 +92,12 @@
/**
* Method associated to a tile and called immediately before the tile is included.
- * This implementation call a Struts Action. No servlet is set by this method.
+ * This implementation calls a Struts Action. No servlet is set by this method.
*
* @param tileContext Current tile context.
- * @param request Current request
- * @param response Current response
- * @param servletContext Current servlet context
+ * @param request Current request.
+ * @param response Current response.
+ * @param servletContext Current servlet context.
*/
public void perform(ComponentContext tileContext,
HttpServletRequest request, HttpServletResponse response,
1.2 +9 -4 jakarta-struts/src/share/org/apache/struts/tiles/UntyppedAttribute.java
Index: UntyppedAttribute.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/UntyppedAttribute.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- UntyppedAttribute.java 25 Jun 2002 03:14:49 -0000 1.1
+++ UntyppedAttribute.java 27 Feb 2003 19:20:50 -0000 1.2
@@ -68,13 +68,14 @@
public class UntyppedAttribute implements AttributeDefinition {
/**
- * Role associated to this attribute
+ * Role associated to this attribute.
*/
protected String role;
protected Object value;
/**
* Constructor.
+ * @param value Object to store.
*/
public UntyppedAttribute( Object value )
{
@@ -83,6 +84,8 @@
/**
* Constructor.
+ * @param value Object to store.
+ * @param role Asociated role.
*/
public UntyppedAttribute( Object value, String role )
{
@@ -100,6 +103,7 @@
/**
* Set role.
+ * @param role Associated role.
*/
public void setRole(String role)
{
@@ -116,6 +120,7 @@
/**
* Set value.
+ * @param value New value.
*/
public void setValue( Object value )
{
1.4 +30 -30 jakarta-struts/src/share/org/apache/struts/tiles/TilesUtilStrutsModulesImpl.java
Index: TilesUtilStrutsModulesImpl.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/TilesUtilStrutsModulesImpl.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TilesUtilStrutsModulesImpl.java 5 Jan 2003 01:24:48 -0000 1.3
+++ TilesUtilStrutsModulesImpl.java 27 Feb 2003 19:20:50 -0000 1.4
@@ -78,12 +78,12 @@
* Methods in this implementation are aware of the Struts module context.
* <br>
* <ul>
- * <li>The method getFactory(...) return the factory for the current struts
+ * <li>The method getFactory(...) returns the factory for the current Struts
* module.</li>
* <li>Methods doForward() and doInclude() use their counterparts in the
* current RequestProcessor (todo).</li>
* <li>The method createFactory(...) creates a factory for the current module and
- * stores it under appropriate property name.</li>
+ * stores it under the appropriate property name.</li>
* </ul>
*/
public class TilesUtilStrutsModulesImpl extends TilesUtilStrutsImpl {
@@ -92,10 +92,10 @@
* Do a forward using request dispatcher.
*
* This method is used by the Tiles package anytime a forward is required.
- * @param uri Uri or Definition name to forward
- * @param request Current page request
- * @param response Current page response
- * @param servletContext Current servlet context
+ * @param uri Uri or Definition name to forward.
+ * @param request Current page request.
+ * @param response Current page response.
+ * @param servletContext Current servlet context.
*/
public void doForward( String uri,
HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
@@ -109,10 +109,10 @@
* Do an include using request dispatcher.
*
* This method is used by the Tiles package anytime an include is required.
- * @param uri Uri or Definition name to forward
- * @param request Current page request
- * @param response Current page response
- * @param servletContext Current servlet context
+ * @param uri Uri or Definition name to forward.
+ * @param request Current page request.
+ * @param response Current page response.
+ * @param servletContext Current servlet context.
*/
public void doInclude(String uri,
HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
@@ -123,9 +123,9 @@
}
/**
- * Get definition factory from appropriate servlet context.
- * @request Current request
- * @servletContext Current servlet context
+ * Get the definition factory from appropriate servlet context.
+ * @param request Current request.
+ * @param servletContext Current servlet context.
* @return Definitions factory or null if not found.
*/
public DefinitionsFactory getDefinitionsFactory( ServletRequest request, ServletContext servletContext)
@@ -135,8 +135,8 @@
/**
* Get definition factory for the module attached to specified moduleConfig.
- * @servletContext Current servlet context
- * @moduleConfig Module config of the module for which the factory is requested.
+ * @param servletContext Current servlet context.
+ * @param moduleConfig Module config of the module for which the factory is requested.
* @return Definitions factory or null if not found.
*/
public DefinitionsFactory getDefinitionsFactory(ServletContext servletContext, ModuleConfig moduleConfig)
@@ -170,10 +170,10 @@
}
*/
/**
- * Make definition factory accessible to Tags.
+ * Make definition factory accessible to tags.
* Factory is stored in servlet context.
- * @param factory Factory to make accessible
- * @param servletContext Current servlet context
+ * @param factory Factory to be made accessible.
+ * @param servletContext Current servlet context.
*/
protected void makeDefinitionsFactoryAccessible( DefinitionsFactory factory, ServletContext servletContext)
{
@@ -182,10 +182,10 @@
}
/**
- * Get Tiles request processor associated to the current module.
- * @request Current request
- * @servletContext Current servlet context*
- * @return The TilesRequestProcessor for current request
+ * Get Tiles RequestProcessor associated to the current module.
+ * @param request Current request.
+ * @param servletContext Current servlet context.
+ * @return The {@link TilesRequestProcessor} for the current request.
*/
protected TilesRequestProcessor getRequestProcessor( HttpServletRequest request, ServletContext servletContext)
{
@@ -196,11 +196,11 @@
/**
* Get the current ModuleConfig.
* <br>
- * Lookup in the request, and do selectModule if not found. The side effect
- * is that the ModuleConfig object is set in the request if it was not present.
- * @request Current request
- * @servletContext Current servlet context*
- * @return The ModuleConfig for current request
+ * Lookup in the request and do selectModule if not found. The side effect
+ * is, that the ModuleConfig object is set in the request if it was not present.
+ * @param request Current request.
+ * @param servletContext Current servlet context*.
+ * @return The ModuleConfig for current request.
*/
protected ModuleConfig getModuleConfig( HttpServletRequest request, ServletContext servletContext)
{
1.3 +10 -10 jakarta-struts/src/share/org/apache/struts/tiles/TilesUtilStrutsImpl.java
Index: TilesUtilStrutsImpl.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/TilesUtilStrutsImpl.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TilesUtilStrutsImpl.java 5 Jan 2003 01:24:48 -0000 1.2
+++ TilesUtilStrutsImpl.java 27 Feb 2003 19:20:50 -0000 1.3
@@ -70,17 +70,17 @@
* TilesUtil implementation for Struts 1.1 with one single factory.
* This class contains default implementation of utilities. This implementation
* is intended to be used with Struts 1.1.
- * This class is used as the base class for all struts 1.1 implementation of TilesUtil.
+ * This class is used as the base class for all Struts 1.1 implementations of TilesUtil.
*/
public class TilesUtilStrutsImpl extends TilesUtilImpl
{
/**
* Return the <code>Class</code> object for the specified fully qualified
- * class name, from the struts class loader.
+ * class name from the Struts class loader.
*
- * @param className Fully qualified class name to be loaded
- * @return Class object
+ * @param className Fully qualified class name to be loaded.
+ * @return Class object.
* @exception ClassNotFoundException if the class cannot be found
*/
public Class applicationClass(String className) throws ClassNotFoundException
@@ -89,9 +89,9 @@
}
/**
- * Get definition factory for the module attached to specified moduleConfig.
- * @servletContext Current servlet context
- * @moduleConfig Module config of the module for which the factory is requested.
+ * Get definition factory for the module attached to the specified moduleConfig.
+ * @param servletContext Current servlet context
+ * @param moduleConfig Module config of the module for which the factory is requested.
* @return Definitions factory or null if not found.
*/
public DefinitionsFactory getDefinitionsFactory(ServletContext servletContext, ModuleConfig moduleConfig)
1.2 +25 -25 jakarta-struts/src/share/org/apache/struts/tiles/TilesUtilImpl.java
Index: TilesUtilImpl.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/TilesUtilImpl.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TilesUtilImpl.java 27 Dec 2002 10:41:23 -0000 1.1
+++ TilesUtilImpl.java 27 Feb 2003 19:20:50 -0000 1.2
@@ -76,8 +76,8 @@
/**
* Default implementation of TilesUtil.
- * This class conatains default implementation of utilities. This implementation
- * is intended to be used without Struts
+ * This class contains default implementation of utilities. This implementation
+ * is intended to be used without Struts.
*/
public class TilesUtilImpl implements Serializable
{
@@ -91,9 +91,9 @@
* Do a forward using request dispatcher.
*
* This method is used by the Tiles package anytime a forward is required.
- * @param uri Uri or Definition name to forward
- * @param request Current page request
- * @param servletContext Current servlet context
+ * @param uri Uri or Definition name to forward.
+ * @param request Current page request.
+ * @param servletContext Current servlet context.
*/
public void doForward(String uri, HttpServletRequest request, HttpServletResponse response,
ServletContext servletContext)
@@ -106,10 +106,10 @@
* Do an include using request dispatcher.
*
* This method is used by the Tiles package anytime an include is required.
- * @param uri Uri or Definition name to forward
- * @param request Current page request
- * @param response Current page response
- * @param servletContext Current servlet context
+ * @param uri Uri or Definition name to forward.
+ * @param request Current page request.
+ * @param response Current page response.
+ * @param servletContext Current servlet context.
*/
public void doInclude(String uri, HttpServletRequest request, HttpServletResponse response,
ServletContext servletContext)
@@ -120,7 +120,7 @@
/**
* Get definition factory from appropriate servlet context.
- * @return Definitions factory or null if not found.
+ * @return Definitions factory or <code>null</code> if not found.
*/
public DefinitionsFactory getDefinitionsFactory(ServletRequest request, ServletContext servletContext)
{
@@ -129,11 +129,11 @@
/**
* Create Definition factory from specified configuration object.
- * Create an instance of the factory , with the class specified in the config
- * object. Then, initialize this factory, and finally store the factory in
- * appropriate context by the way of
+ * Create an instance of the factory with the class specified in the config
+ * object. Then, initialize this factory and finally store the factory in
+ * appropriate context by calling
* {@link #makeDefinitionsFactoryAccessible(DefinitionsFactory, ServletContext)}.
- * Factory creation is done by the way of {@link #createDefinitionFactoryInstance(String)}
+ * Factory creation is done by {@link #createDefinitionFactoryInstance(String)}.
* <p>
*
* @param servletContext Servlet Context passed to newly created factory.
@@ -154,9 +154,9 @@
/**
* Create Definition factory of specified classname.
- * Factory class must extends the {@link DefinitionsFactory} class.
+ * Factory class must extend the {@link DefinitionsFactory} class.
* The factory is wrapped appropriately with {@link ComponentDefinitionsFactoryWrapper}
- * if it is instance of the deprecated ComponentDefinitionsFactory class.
+ * if it is an instance of the deprecated ComponentDefinitionsFactory class.
* @param classname Class name of the factory to create.
* @return newly created factory.
* @throws DefinitionsFactoryException If an error occur while initializing factory
@@ -180,7 +180,7 @@
catch( ClassCastException ex )
{ // Bad classname
throw new DefinitionsFactoryException( "Error - createDefinitionsFactory : Factory class '"
- + classname +" must implements 'TilesDefinitionsFactory'.", ex );
+ + classname +" must implement 'TilesDefinitionsFactory'.", ex );
}
catch( ClassNotFoundException ex )
{ // Bad classname
@@ -199,8 +199,8 @@
/**
* Make definition factory accessible to Tags.
* Factory is stored in servlet context.
- * @param factory Factory to make accessible
- * @param servletContext Current servlet context
+ * @param factory Factory to be made accessible.
+ * @param servletContext Current servlet context.
*/
protected void makeDefinitionsFactoryAccessible(DefinitionsFactory factory, ServletContext servletContext)
{
@@ -209,10 +209,10 @@
/**
* Return the <code>Class</code> object for the specified fully qualified
- * class name, from the underlying class loader.
+ * class name from the underlying class loader.
*
- * @param className Fully qualified class name to be loaded
- * @return Class object
+ * @param className Fully qualified class name to be loaded.
+ * @return Class object.
* @exception ClassNotFoundException if the class cannot be found
*/
public Class applicationClass(String className) throws ClassNotFoundException
1.5 +25 -26 jakarta-struts/src/share/org/apache/struts/tiles/TilesUtil.java
Index: TilesUtil.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/TilesUtil.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TilesUtil.java 27 Dec 2002 10:41:23 -0000 1.4
+++ TilesUtil.java 27 Feb 2003 19:20:50 -0000 1.5
@@ -73,17 +73,15 @@
import org.apache.commons.logging.LogFactory;
/**
- * Class containing utilities for Tiles.
- * Methods of this class are static, and so are accessible from anywhere.
+ * Class containing utility methods for Tiles.
+ * Methods of this class are static and thereby accessible from anywhere.
* The underlying implementation can be changed with
* {@link void setTilesUtil(TilesUtilImpl tilesUtil)}.
* <br>
- * Real implementation classes should derive from the {@link TilesUtilImpl } class.
+ * Real implementation classes should derive from the {@link TilesUtilImpl} class.
* <br>
* Some methods are specified to throw the <code>UnsupportedOperationException</code>
* if the underlying implementation doesn't support the operation.
- *
- *
*/
public class TilesUtil
{
@@ -106,6 +104,7 @@
* Set the real implementation.
* This method should be called only once.
* Successive calls have no effect.
+ * @param tilesUtil The implementaion.
*/
static public void setTilesUtil(TilesUtilImpl tilesUtil)
{
@@ -118,7 +117,7 @@
/**
* Getter to know if the underlying implementation is already set to another
* value than the default value.
- * @return true if setTilesUtil() has already been called.
+ * @return <code>true</code> if {@link #setTilesUtil} has already been called.
*/
static boolean isTilesUtilImplSet()
{
@@ -126,17 +125,17 @@
}
- /** Flag to know if internal implementation have been set by the setter method */
+ /** Flag to know if internal implementation has been set by the setter method */
private static boolean implAlreadySet=false;
/**
* Do a forward using request dispatcher.
*
* This method is used by the Tiles package anytime a forward is required.
- * @param uri Uri or Definition name to forward
- * @param request Current page request
- * @param response Current page response
- * @param servletContext Current servlet context
+ * @param uri Uri or Definition name to forward.
+ * @param request Current page request.
+ * @param response Current page response.
+ * @param servletContext Current servlet context.
*/
public static void doForward(String uri, HttpServletRequest request, HttpServletResponse response,
ServletContext servletContext)
@@ -149,10 +148,10 @@
* Do an include using request dispatcher.
*
* This method is used by the Tiles package anytime an include is required.
- * @param uri Uri or Definition name to forward
- * @param request Current page request
- * @param response Current page response
- * @param servletContext Current servlet context
+ * @param uri Uri or Definition name to forward.
+ * @param request Current page request.
+ * @param response Current page response.
+ * @param servletContext Current servlet context.
*/
public static void doInclude(String uri, HttpServletRequest request, HttpServletResponse response,
ServletContext servletContext)
@@ -163,7 +162,7 @@
/**
* Get definition factory from appropriate servlet context.
- * @return Definitions factory or null if not found.
+ * @return Definitions factory or <code>null</code> if not found.
*/
static public DefinitionsFactory getDefinitionsFactory(ServletRequest request, ServletContext servletContext)
{
@@ -173,7 +172,7 @@
/**
* Create Definition factory from specified configuration object.
* Create a ConfigurableDefinitionsFactory and initialize it with the configuration
- * object. This later can contains the factory classname to use.
+ * object. This later can contain the factory classname to use.
* Factory is made accessible from tags.
* <p>
* Fallback of several factory creation methods.
@@ -191,11 +190,11 @@
/**
* Get a definition by its name.
- * First, retrieve definition factory, and then get requested definition.
+ * First, retrieve definition factory and then get requested definition.
* Throw appropriate exception if definition or definition factory is not found.
* @param definitionName Name of requested definition.
- * @param request Current servelet request
- * @param servletContext current servlet context
+ * @param request Current servelet request.
+ * @param servletContext current servlet context.
* @throws FactoryNotFoundException Can't find definition factory.
* @throws DefinitionsFactoryException General error in factory while getting definition.
* @throws NoSuchDefinitionException No definition found for specified name
@@ -217,10 +216,10 @@
/**
* Return the <code>Class</code> object for the specified fully qualified
- * class name, from the underlying class loader.
+ * class name from the underlying class loader.
*
- * @param className Fully qualified class name to be loaded
- * @return Class object
+ * @param className Fully qualified class name to be loaded.
+ * @return Class object.
* @exception ClassNotFoundException if the class cannot be found
*/
public static Class applicationClass(String className) throws ClassNotFoundException
1.17 +41 -43 jakarta-struts/src/share/org/apache/struts/tiles/TilesRequestProcessor.java
Index: TilesRequestProcessor.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/TilesRequestProcessor.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- TilesRequestProcessor.java 27 Dec 2002 10:57:01 -0000 1.16
+++ TilesRequestProcessor.java 27 Feb 2003 19:20:50 -0000 1.17
@@ -76,13 +76,13 @@
/**
* <p><strong>RequestProcessor</strong> contains the processing logic that
* the Struts controller servlet performs as it receives each servlet request
- * from the container. </p>
- * <p>This processor subclass the Struts one in order to intercept calls to forward
- * or include. When such call is done, Tiles processor check if the specified uri
+ * from the container.</p>
+ * <p>This processor subclasses the Struts one in order to intercept calls to forward
+ * or include. When such calls are done, the Tiles processor checks if the specified uri
* is a definition name. If true, the definition is retrieved and included. If
* false, the original uri is included or a forward is performed.
* <p>
- * Actually, catching is done by overloading following methods:
+ * Actually, catching is done by overloading the following methods:
* <ul>
* <li>{@link #processForwardConfig(HttpServletRequest,HttpServletResponse,ForwardConfig)}</li>
* <li>{@link #internalModuleRelativeForward(String, HttpServletRequest , HttpServletResponse)}</li>
@@ -105,9 +105,9 @@
/**
* Initialize this request processor instance.
*
- * @param servlet The ActionServlet we are associated with
+ * @param servlet The ActionServlet we are associated with.
* @param moduleConfig The ModuleConfig we are associated with.
- * @throws ServletException If an error occur during initialization
+ * @throws ServletException If an error occurs during initialization.
*/
public void init(ActionServlet servlet, ModuleConfig moduleConfig)
throws ServletException
@@ -119,7 +119,6 @@
/**
* Read component instance mapping configuration file.
* This is where we read files properties.
- * @param moduleConfig The ModuleConfig we are associated with.
*/
protected void initDefinitionsMapping() throws ServletException
{
@@ -144,15 +143,15 @@
/**
* Process a Tile definition name.
- * This method try to process parameter definitionName as a definition name.
- * It return true if a definition has been processed, false otherwise.
- * Parameter contextRelative is not use in this implementation.
+ * This method tries to process the parameter <code>definitionName</code> as a definition name.
+ * It returns <code>true</code> if a definition has been processed, or <code>false</code> otherwise.
+ * Parameter <code>contextRelative</code> is not used in this implementation.
*
* @param definitionName Definition name to insert.
- * @param contextRelative Does the Definition is marked contextRelative ?
- * @param request Current page request
- * @param response Current page response
- * @return True if the method has process uri as a definition name, false otherwise.
+ * @param contextRelative Is the definition marked contextRelative ?
+ * @param request Current page request.
+ * @param response Current page response.
+ * @return <code>true</code> if the method has processed uri as a definition name, <code>false</code> otherwise.
*/
protected boolean processTilesDefinition(String definitionName, boolean contextRelative, HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException
@@ -253,12 +252,11 @@
/**
* Do a forward using request dispatcher.
- *
* Uri is a valid uri. If response has already been commited, do an include
* instead.
- * @param uri Uri or Definition name to forward
- * @param request Current page request
- * @param response Current page response
+ * @param uri Uri or Definition name to forward.
+ * @param request Current page request.
+ * @param response Current page response.
*/
protected void doForward(String uri, HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException
@@ -270,18 +268,18 @@
}
/**
- * Overloaded method from Struts RequestProcessor.
- * Forward or redirect to the specified destination, by the specified
+ * Overloaded method from Struts' RequestProcessor.
+ * Forward or redirect to the specified destination by the specified
* mechanism.
- * This method catch the struts actionForward call. It checks if the
+ * This method catches the Struts' actionForward call. It checks if the
* actionForward is done on a Tiles definition name. If true, process the
- * definition, and insert it. If false, call the original parent's method.
- * @param request The servlet request we are processing
- * @param response The servlet response we are creating
- * @param forward The ActionForward controlling where we go next
+ * definition and insert it. If false, call the original parent's method.
+ * @param request The servlet request we are processing.
+ * @param response The servlet response we are creating.
+ * @param forward The ActionForward controlling where we go next.
*
- * @exception IOException if an input/output error occurs
- * @exception ServletException if a servlet exception occurs
+ * @exception IOException if an input/output error occurs.
+ * @exception ServletException if a servlet exception occurs.
*/
protected void processForwardConfig(HttpServletRequest request,
HttpServletResponse response,
@@ -315,15 +313,15 @@
/**
* Catch the call to a module relative forward.
* If the specified uri is a tiles definition name, insert it.
- * Otherwise, parent processing is called
+ * Otherwise, parent processing is called.
* Do a module relative forward to specified uri using request dispatcher.
- * Uri is relative to the current module. The real uri is compute by prefixing
+ * Uri is relative to the current module. The real uri is computed by prefixing
* the module name.
- * This method is used internally and is not part of the public API. It is
- * advice to not use it in subclasses.
- * @param uri Module-relative URI to forward to
- * @param request Current page request
- * @param response Current page response
+ * <strong>This method is used internally and is not part of the public API. It is
+ * advised to not use it in subclasses.</strong>
+ * @param uri Module-relative URI to forward to.
+ * @param request Current page request.
+ * @param response Current page response.
* @since Struts 1.1
*/
protected void internalModuleRelativeForward(String uri, HttpServletRequest request,
@@ -338,13 +336,13 @@
/**
* Do a module relative include to specified uri using request dispatcher.
- * Uri is relative to the current module. The real uri is compute by prefixing
+ * Uri is relative to the current module. The real uri is computed by prefixing
* the module name.
- * This method is used internally and is not part of the public API. It is
- * advice to not use it in subclasses.
- * @param uri Module-relative URI to forward to
- * @param request Current page request
- * @param response Current page response
+ * <strong>This method is used internally and is not part of the public API. It is
+ * advice to not use it in subclasses.</strong>
+ * @param uri Module-relative URI to forward to.
+ * @param request Current page request.
+ * @param response Current page response.
* @since Struts 1.1
*/
protected void internalModuleRelativeInclude(String uri, HttpServletRequest request,
1.19 +40 -41 jakarta-struts/src/share/org/apache/struts/tiles/TilesPlugin.java
Index: TilesPlugin.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/TilesPlugin.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- TilesPlugin.java 5 Jan 2003 01:24:48 -0000 1.18
+++ TilesPlugin.java 27 Feb 2003 19:20:50 -0000 1.19
@@ -79,24 +79,24 @@
/**
* Tiles Plugin used to initialize Tiles.
* This plugin is to be used with Struts 1.1 in association with
- * TilesRequestProcessor.
+ * {@link TilesRequestProcessor}.
* <br>
- * This plugin create one definition factory for each struts module. The definition factory
+ * This plugin creates one definition factory for each Struts-module. The definition factory
* configuration is read first from 'web.xml' (backward compatibility), then it is
- * overloaded by values found in plugin property values.
+ * overloaded with values found in the plugin property values.
* <br>
- * The plugin changes Struts configuration by specifying a TilesRequestProcessor as
- * request processor. If the user has also specified another request processor,
- * this later should subclass TilesRequestProcessor.
+ * The plugin changes the Struts configuration by specifying a {@link TilesRequestProcessor} as
+ * request processor. If you want to use your own RequestProcessor,
+ * it should subclass TilesRequestProcessor.
* <br>
- * This plugin can also be used to create one single factory for all module.
- * This behavior is enable by specifying <code>moduleAware=false</code> in each
+ * This plugin can also be used to create one single factory for all modules.
+ * This behavior is enabled by specifying <code>moduleAware=false</code> in each
* plugin properties. In this case, the definition factory
- * configuration file is read by the first tiles plugin to be initialized. The order is
+ * configuration file is read by the first Tiles plugin to be initialized. The order is
* determined by the order of modules declaration in web.xml. The first module
* is always the default one if it exists.
* The plugin should be declared in each struts-config.xml file in order to
- * properly intialize the request processor.
+ * properly initialize the request processor.
* @author Cedric Dumoulin
* @since 1.1
*/
@@ -105,7 +105,7 @@
/** Commons Logging instance. */
protected static Log log = LogFactory.getLog(TilesPlugin.class);
- /** Does the factory is module aware ? */
+ /** Is the factory module aware ? */
protected boolean moduleAware = false;
/** Tiles util implementation classname. This property can be set
@@ -123,8 +123,8 @@
/**
* Get the module aware flag.
- * true: user want a single factory instance
- * false: user want multiple factory instance (one per module with Struts)
+ * @return <code>true</code>: user wants a single factory instance,
+ * <code>false:</code> user wants multiple factory instances (one per module with Struts)
*/
public boolean isModuleAware() {
return moduleAware;
@@ -132,11 +132,10 @@
/**
* Set the module aware flag.
- * true: user want a single factory instance
- * false: user want multiple factory instance (one per module with Struts)
- * This flag is meaningfull only if the property tilesUtilImplClassname is not
+ * This flag is only meaningful if the property <code>tilesUtilImplClassname</code> is not
* set.
- * @param moduleAware
+ * @param moduleAware <code>true</code>: user wants a single factory instance,
+ * <code>false:</code> user wants multiple factory instances (one per module with Struts)
*/
public void setModuleAware(boolean moduleAware) {
this.moduleAware = moduleAware;
@@ -147,12 +146,12 @@
* started up.</p>
*
* @param servlet ActionServlet that is managing all the modules
- * in this web application
+ * in this web application.
* @param moduleConfig ModuleConfig for the module with which
- * this plug in is associated
+ * this plugin is associated.
*
* @exception ServletException if this <code>PlugIn</code> cannot
- * be successfully initialized
+ * be successfully initialized.
*/
public void init(ActionServlet servlet, ModuleConfig moduleConfig) throws ServletException
{
@@ -248,11 +247,11 @@
* Create FactoryConfig and initialize it from web.xml and struts-config.xml.
*
* @param servlet ActionServlet that is managing all the modules
- * in this web application
+ * in this web application.
* @param config ModuleConfig for the module with which
- * this plug in is associated
+ * this plugin is associated.
* @exception ServletException if this <code>PlugIn</code> cannot
- * be successfully initialized
+ * be successfully initialized.
*/
protected DefinitionsFactoryConfig readFactoryConfig( ActionServlet servlet, ModuleConfig config)
throws ServletException
@@ -290,16 +289,16 @@
}
/**
- * Find original properties set in the struts PlugInConfig object.
- * First, need to find the index of this plugin. Then retrieve array of configs
+ * Find original properties set in the Struts PlugInConfig object.
+ * First, we need to find the index of this plugin. Then we retrieve the array of configs
* and then the object for this plugin.
* @param servlet ActionServlet that is managing all the modules
- * in this web application
+ * in this web application.
* @param config ModuleConfig for the module with which
- * this plug in is associated
+ * this plug in is associated.
*
* @exception ServletException if this <code>PlugIn</code> cannot
- * be successfully initialized
+ * be successfully initialized.
*/
protected Map findStrutsPlugInConfigProperties(ActionServlet servlet, ModuleConfig config)
throws ServletException
@@ -308,14 +307,14 @@
}
/**
- * Set RequestProcessor to appropriate Tiles RequestProcessor.
- * First check if a requestprocessor is specified. If yes, check if it extends
- * appropriate TilesRequestProcessor class. If no, set processor class to
- * TilesRequestProcessor
+ * Set RequestProcessor to appropriate Tiles {@link RequestProcessor}.
+ * First, check if a RequestProcessor is specified. If yes, check if it extends
+ * the appropriate {@link TilesRequestProcessor} class. If not, set processor class to
+ * TilesRequestProcessor.
*
* @param config ModuleConfig for the module with which
- * this plug in is associated
- * @throws ServletException If an error occur
+ * this plugin is associated.
+ * @throws ServletException On errors.
*/
protected void initRequestProcessorClass(ModuleConfig config) throws ServletException
{
@@ -361,8 +360,8 @@
/**
* Set Tiles util implemention classname.
- * If this property is set, the flag "moduleAware" will not be used anymore.
- * @param tilesUtilImplClassname
+ * If this property is set, the flag <code>moduleAware</code> will not be used anymore.
+ * @param tilesUtilImplClassname Classname.
*/
public void setTilesUtilImplClassname(String tilesUtilImplClassname)
{
@@ -370,7 +369,7 @@
}
/**
* Get Tiles util implemention classname.
- * @return the classname or null if none is set.
+ * @return The classname or <code>null</code> if none is set.
*/
public String getTilesUtilImplClassname()
{
@@ -380,7 +379,7 @@
/**
* Method used by the ActionServlet initializing this plugin.
* Set the plugin config object read from module config.
- * @param plugInConfigObject
+ * @param plugInConfigObject PlugInConfig.
*/
public void setCurrentPlugInConfigObject(PlugInConfig plugInConfigObject)
{
1.2 +15 -21 jakarta-struts/src/share/org/apache/struts/tiles/TilesException.java
Index: TilesException.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/TilesException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TilesException.java 25 Jun 2002 03:14:49 -0000 1.1
+++ TilesException.java 27 Feb 2003 19:20:51 -0000 1.2
@@ -64,7 +64,7 @@
/**
- * Root class of Tiles exception
+ * Root class for all Tiles-exceptions.
* @author Cedric Dumoulin
*/
public class TilesException extends Exception
@@ -76,11 +76,8 @@
* @serial
*/
private Exception exception;
- /**
- * Constructor.
- * Create a new MapperFactoryException.
- *
- * @param message The error or warning message.
+ /**
+ * Constructor.
*/
public TilesException()
{
@@ -88,10 +85,8 @@
this.exception = null;
}
- /**
- * Constructor.
- * Create a new MapperFactoryException.
- *
+ /**
+ * Constructor.
* @param message The error or warning message.
*/
public TilesException(String message)
@@ -102,13 +97,13 @@
/**
- * Create a new MapperFactoryException wrapping an existing exception.
+ * Create a new <code>TilesException</code> wrapping an existing exception.
*
* <p>The existing exception will be embedded in the new
* one, and its message will become the default message for
- * the MapperFactoryException.</p>
+ * the TilesException.</p>
*
- * @param e The exception to be wrapped in a SAXException.
+ * @param e The exception to be wrapped.
*/
public TilesException(Exception e)
{
@@ -118,14 +113,13 @@
/**
- * Create a new MapperFactoryException from an existing exception.
+ * Create a new <code>TilesException</code> from an existing exception.
*
* <p>The existing exception will be embedded in the new
* one, but the new exception will have its own message.</p>
*
* @param message The detail message.
- * @param e The exception to be wrapped in a MapperFactoryException.
- * @see org.xml.sax.Parser#setLocale
+ * @param e The exception to be wrapped.
*/
public TilesException(String message, Exception e)
{
@@ -137,7 +131,7 @@
/**
* Return a detail message for this exception.
*
- * <p>If there is a embedded exception, and if the MapperFactoryException
+ * <p>If there is a embedded exception, and if the TilesException
* has no detail message of its own, this method will return
* the detail message from the embedded exception.</p>
*
@@ -158,7 +152,7 @@
/**
* Return the embedded exception, if any.
*
- * @return The embedded exception, or null if there is none.
+ * @return The embedded exception, or <code>null</code> if there is none.
*/
public Exception getException ()
{
1.3 +4 -4 jakarta-struts/src/share/org/apache/struts/tiles/PathAttribute.java
Index: PathAttribute.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/PathAttribute.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PathAttribute.java 5 Jan 2003 01:24:48 -0000 1.2
+++ PathAttribute.java 27 Feb 2003 19:20:51 -0000 1.3
@@ -64,7 +64,7 @@
/**
* Component attribute.
- * Such attribute value represent a path used to include a JSP.
+ * Attribute value represents a path used to include a JSP.
*/
public class PathAttribute extends UntyppedAttribute {
1.2 +5 -4 jakarta-struts/src/share/org/apache/struts/tiles/NoSuchDefinitionException.java
Index: NoSuchDefinitionException.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/NoSuchDefinitionException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NoSuchDefinitionException.java 25 Jun 2002 03:14:49 -0000 1.1
+++ NoSuchDefinitionException.java 27 Feb 2003 19:20:51 -0000 1.2
@@ -63,7 +63,7 @@
package org.apache.struts.tiles;
/**
- * Exception throw when an instance is not found.
+ * Exception thrown when a definition is not found.
*/
public class NoSuchDefinitionException extends DefinitionsFactoryException
{
@@ -76,6 +76,7 @@
}
/**
* Constructor.
+ * @param msg Message.
*/
public NoSuchDefinitionException( String msg )
{
1.2 +5 -4 jakarta-struts/src/share/org/apache/struts/tiles/FactoryNotFoundException.java
Index: FactoryNotFoundException.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/FactoryNotFoundException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FactoryNotFoundException.java 25 Jun 2002 03:14:49 -0000 1.1
+++ FactoryNotFoundException.java 27 Feb 2003 19:20:51 -0000 1.2
@@ -63,7 +63,7 @@
package org.apache.struts.tiles;
/**
- * Exception throw when instances factory is not found.
+ * Exception thrown when definitions factory is not found.
*/
public class FactoryNotFoundException extends DefinitionsFactoryException
{
@@ -76,6 +76,7 @@
}
/**
* Constructor.
+ * @param msg Message.
*/
public FactoryNotFoundException( String msg )
{
1.2 +16 -23 jakarta-struts/src/share/org/apache/struts/tiles/DefinitionsFactoryException.java
Index: DefinitionsFactoryException.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/DefinitionsFactoryException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DefinitionsFactoryException.java 25 Jun 2002 03:14:49 -0000 1.1
+++ DefinitionsFactoryException.java 27 Feb 2003 19:20:51 -0000 1.2
@@ -63,16 +63,13 @@
package org.apache.struts.tiles;
/**
- * Exception throw when an error occur while factory try to
+ * Exception thrown when an error occurs while the factory tries to
* create a new instance mapper.
*/
public class DefinitionsFactoryException extends TilesException
{
- /**
- * Constructor.
- * Create a new MapperFactoryException.
- *
- * @param message The error or warning message.
+ /**
+ * Constructor.
*/
public DefinitionsFactoryException()
{
@@ -80,10 +77,8 @@
this.exception = null;
}
- /**
- * Constructor.
- * Create a new MapperFactoryException.
- *
+ /**
+ * Constructor.
* @param message The error or warning message.
*/
public DefinitionsFactoryException(String message)
@@ -94,13 +89,13 @@
/**
- * Create a new MapperFactoryException wrapping an existing exception.
+ * Create a new <code>DefinitionsFactoryException</code> wrapping an existing exception.
*
* <p>The existing exception will be embedded in the new
- * one, and its message will become the default message for
- * the MapperFactoryException.</p>
+ * one and its message will become the default message for
+ * the DefinitionsFactoryException.</p>
*
- * @param e The exception to be wrapped in a SAXException.
+ * @param e The exception to be wrapped.
*/
public DefinitionsFactoryException(Exception e)
{
@@ -110,14 +105,13 @@
/**
- * Create a new MapperFactoryException from an existing exception.
+ * Create a new <code>DefinitionsFactoryException</code> from an existing exception.
*
* <p>The existing exception will be embedded in the new
* one, but the new exception will have its own message.</p>
*
* @param message The detail message.
- * @param e The exception to be wrapped in a MapperFactoryException.
- * @see org.xml.sax.Parser#setLocale
+ * @param e The exception to be wrapped.
*/
public DefinitionsFactoryException(String message, Exception e)
{
@@ -129,7 +123,7 @@
/**
* Return a detail message for this exception.
*
- * <p>If there is a embedded exception, and if the MapperFactoryException
+ * <p>If there is a embedded exception, and if the DefinitionsFactoryException
* has no detail message of its own, this method will return
* the detail message from the embedded exception.</p>
*
@@ -149,8 +143,7 @@
/**
* Return the embedded exception, if any.
- *
- * @return The embedded exception, or null if there is none.
+ * @return The embedded exception, or <code>null</code> if there is none.
*/
public Exception getException ()
{
1.7 +45 -52 jakarta-struts/src/share/org/apache/struts/tiles/DefinitionsFactoryConfig.java
Index: DefinitionsFactoryConfig.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/DefinitionsFactoryConfig.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- DefinitionsFactoryConfig.java 25 Feb 2003 04:58:30 -0000 1.6
+++ DefinitionsFactoryConfig.java 27 Feb 2003 19:20:51 -0000 1.7
@@ -120,7 +120,7 @@
* With Struts 1.1, this name is the module name to which this factory
* belong. It is set by the system.
* <br>
- * In other versions, this properties is not used.
+ * In prior versions, this property is not used.
*/
protected String factoryName;
@@ -153,7 +153,7 @@
* Create configuration object, and initialize it with parameters from Map.
* Parameters corresponding to an attribute are filtered and stored in appropriate
* attribute.
- * @param initParameters
+ * @param initParameters Map.
*/
public DefinitionsFactoryConfig(Map initParameters)
{
@@ -162,8 +162,8 @@
/**
* Get the module aware flag.
- * true: user want a single factory instance
- * false: user want multiple factory instance (one per module with Struts)
+ * @return <code>true</code>: user wants a single factory instance,
+ * <code>false</code>: user wants multiple factory instances (one per module with Struts)
*/
public boolean isModuleAware()
{
@@ -171,9 +171,8 @@
}
/**
* Set the module aware flag.
- * true: user want a single factory instance
- * false: user want multiple factory instance (one per module with Struts)
- * @param singleFactoryInstance
+ * @param moduleAware <code>true</code>: user wants a single factory instance,
+ * <code>false</code>: user wants multiple factory instances (one per module with Struts)
*/
public void setModuleAware(boolean moduleAware)
{
@@ -181,9 +180,8 @@
}
/**
- * Access method for the factoryClassname property.
- *
- * @return the current value of the factoryClassname property
+ * Get the classname of the factory.
+ * @return Classname.
*/
public String getFactoryClassname()
{
@@ -191,9 +189,8 @@
}
/**
- * Sets the value of the factoryClassname property.
- *
- * @param aFactoryClassname the new value of the factoryClassname property
+ * Set the classname of the factory..
+ * @param aFactoryClassname Classname of the factory.
*/
public void setFactoryClassname(String aFactoryClassname)
{
@@ -201,9 +198,9 @@
}
/**
- * Access method for the debugLevel property.
- *
- * @return the current value of the debugLevel property
+ * Get debug level.
+ * @return Debug level.
+ * @deprecated Use commons-logging mechanism.
*/
public int getDebugLevel()
{
@@ -211,9 +208,9 @@
}
/**
- * Sets the value of the debugLevel property.
- *
- * @param aDebugLevel the new value of the debugLevel property
+ * Set debug level.
+ * @param aDebugLevel Debug level.
+ * @deprecated Use commons-logging mechanism.
*/
public void setDebugLevel(int aDebugLevel)
{
@@ -221,9 +218,9 @@
}
/**
- * Access method for the parserDebugLevel property.
- *
- * @return the current value of the parserDebugLevel property
+ * Get the debug level for the parser.
+ * @return Debug level.
+ * @deprecated Use commons-logging mechanism.
*/
public int getParserDebugLevel()
{
@@ -231,9 +228,9 @@
}
/**
- * Sets the value of the parserDebugLevel property.
- *
- * @param aParserDebugLevel the new value of the parserDebugLevel property
+ * Set the debug level for the parser.
+ * @param aParserDebugLevel Debug level.
+ * @deprecated Use commons-logging mechanism.
*/
public void setParserDebugLevel(int aParserDebugLevel)
{
@@ -241,9 +238,8 @@
}
/**
- * Determines if the parserValidate property is true.
- *
- * @return <code>true<code> if the parserValidate property is true
+ * Determines if the parser is validating.
+ * @return <code>true<code> when in validating mode.
*/
public boolean getParserValidate()
{
@@ -251,9 +247,8 @@
}
/**
- * Sets the value of the parserValidate property.
- *
- * @param aParserValidate the new value of the parserValidate property
+ * Set the validating mode for the parser.
+ * @param aParserValidate <code>true</code> for validation, <code>false</code> otherwise
*/
public void setParserValidate(boolean aParserValidate)
{
@@ -261,9 +256,8 @@
}
/**
- * Access method for the definitionConfigFiles property.
- *
- * @return the current value of the definitionConfigFiles property
+ * Get the definition config files.
+ * @return Defition config files.
*/
public String getDefinitionConfigFiles()
{
@@ -271,9 +265,8 @@
}
/**
- * Sets the value of the definitionConfigFiles property.
- *
- * @param aDefinitionConfigFiles the new value of the definitionConfigFiles property
+ * Set the definition config files.
+ * @param aDefinitionConfigFiles Definition config files.
*/
public void setDefinitionConfigFiles(String aDefinitionConfigFiles)
{
@@ -281,7 +274,7 @@
}
/**
- * Set a new extra attribute value.
+ * Set value of an additional attribute.
* @param name Name of the attribute.
* @param value Value of the attribute.
*/
@@ -291,7 +284,7 @@
}
/**
- * Get extra attribute value.
+ * Get value of an additional attribute.
* @param name Name of the attribute.
* @return Value of the attribute, or null if not found.
*/
@@ -301,8 +294,8 @@
}
/**
- * Get extra attributes as a Map.
- * @return Map A Map containing attribute name - value pair.
+ * Get additional attributes as a Map.
+ * @return Map A Map containing attribute name - value pairs.
*/
public Map getAttributes()
{
@@ -325,8 +318,8 @@
* the specified name/value pairs. This method uses the populate() method from
* org.apache.commons.beanutils.BeanUtil.
* <p>
- * Properties keys are scanned for old property names, and linked to new name
- * if necessary. This modify the properties map.
+ * Properties keys are scanned for old property names, and linked to the new name
+ * if necessary. This modifies the properties map.
* <p>
* The particular setter method to be called for each property is
* determined using the usual JavaBeans introspection mechanisms. Thus,
@@ -340,12 +333,12 @@
* signatures) for the same property.
*
* @param properties Map keyed by property name, with the
- * corresponding (String or String[]) value(s) to be set
+ * corresponding (String or String[]) value(s) to be set.
*
* @exception IllegalAccessException if the caller does not have
- * access to the property accessor method
- * @exception InvocationTargetException if the property accessor method
- * throws an exception
+ * access to the property accessor method.
+ * @exception java.lang.reflect.InvocationTargetException if the property accessor method
+ * throws an exception.
* @see org.apache.commons.beanutils.BeanUtils
*/
public void populate( Map properties)
@@ -358,10 +351,9 @@
/**
* Link old property names to new property names.
- * This modify the map.
+ * This modifies the map.
* @param properties Map keyed by property name, with the
- * corresponding (String or String[]) value(s) to be set
- *
+ * corresponding (String or String[]) value(s) to be set.
*/
static public void linkOldPropertyNames( Map properties)
{
@@ -395,6 +387,7 @@
}
/**
* Set the factory name.
+ * @param factoryName Name of the factory.
*/
public void setFactoryName(String factoryName)
{
1.2 +5 -5 jakarta-struts/src/share/org/apache/struts/tiles/ControllerSupport.java
Index: ControllerSupport.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/ControllerSupport.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ControllerSupport.java 25 Jun 2002 03:14:49 -0000 1.1
+++ ControllerSupport.java 27 Feb 2003 19:20:51 -0000 1.2
@@ -75,8 +75,8 @@
{
/**
- * Method associated to a tile and called when immediately before tile is included.
- * This implementation do nothing.
+ * Method associated to a tile and called immediately before tile is included.
+ * This implementation does nothing.
* @param tileContext Current tile context.
* @param request Current request
* @param response Current response
1.2 +24 -42 jakarta-struts/src/share/org/apache/struts/tiles/ComponentContext.java
Index: ComponentContext.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/ComponentContext.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ComponentContext.java 25 Jun 2002 03:14:49 -0000 1.1
+++ ComponentContext.java 27 Feb 2003 19:20:51 -0000 1.2
@@ -84,7 +84,7 @@
private Map attributes;
/**
- * Component attributes.
+ * EmptyIterator over component attributes.
*/
private static Iterator EMPTY_ITERATOR = new EmptyIterator();
@@ -97,7 +97,7 @@
/**
* Constructor.
- * @deprecated Use ComponentContext( Map attributes ) instead.
+ * @deprecated Use {@link #ComponentContext(Map attributes)} instead.
*/
public ComponentContext( ComponentDefinition instance )
{
@@ -114,7 +114,7 @@
/**
* Constructor.
* Create a context and set specified attributes.
- * @param attributes Attributes to initialize context
+ * @param attributes Attributes to initialize context.
*/
public ComponentContext( Map attributes )
{
@@ -127,7 +127,7 @@
* Copies all of the mappings from the specified attribute map to this context.
* New attribute mappings will replace any mappings that this context had for any of the keys
* currently in the specified attribute map.
- * @param attributes to add.
+ * @param newAttributes Attributes to add.
*/
public void addAll(Map newAttributes)
{
@@ -144,7 +144,7 @@
* Copies all of the mappings from the specified attributes map to this context.
* New attribute mappings will be added only if they don't already exist in
* this context.
- * @param attributes to add.
+ * @param defaultAttributes Attributes to add.
*/
public void addMissing(Map defaultAttributes)
{
@@ -169,8 +169,8 @@
}
/**
- * Get an attribute from context
- * @param name
+ * Get an attribute from context.
+ * @param name Name of the attribute.
* @return <{Object}>
*/
public Object getAttribute(String name)
@@ -181,8 +181,7 @@
}
/**
- * Get names of all attributes
- * @param name
+ * Get names of all attributes.
* @return <{Object}>
*/
public Iterator getAttributeNames()
@@ -194,9 +193,8 @@
/**
* Put a new attribute to context.
- * @param name
- * @param value
- * @return void
+ * @param name Name of the attribute.
+ * @param value Value of the attribute.
*/
public void putAttribute(String name, Object value)
{
@@ -208,60 +206,42 @@
/**
* Find object in one of the contexts.
-
* Order : component then pageContext.findAttribute()
-
- * @return requested bean or null if not found.
-
- *
-
+ * @param beanName Name of the bean to find.
+ * @param pageContext Page context.
+ * @return Requested bean or <code>null</code> if not found.
*/
public Object findAttribute( String beanName, PageContext pageContext)
-
{
-
Object attribute = getAttribute(beanName);
-
if( attribute == null )
-
{
-
attribute = pageContext.findAttribute( beanName );
-
} // end if
-
return attribute;
-
}
/**
-
* Get object from requested context.
-
* Context can be 'component'.
-
- * @return requested bean or null if not found.
-
- *
-
+ * @param beanName Name of the bean to find.
+ * @param scope Search scope (see {@link PageContext}).
+ * @param pageContext Page context.
+ * @return requested bean or <code>null</code> if not found.
*/
public Object getAttribute( String beanName, int scope, PageContext pageContext)
-
{
-
if(scope == ComponentConstants.COMPONENT_SCOPE )
-
return getAttribute(beanName);
-
-
return pageContext.getAttribute( beanName, scope );
-
}
/**
* Get component context from request.
+ * @param request ServletRequest.
+ * @return ComponentContext
*/
static public ComponentContext getContext( ServletRequest request )
{
@@ -270,6 +250,8 @@
/**
* Store component context into request.
+ * @param context ComponentContext to store.
+ * @param request Request to store ComponentContext.
*/
static public void setContext( ComponentContext context, ServletRequest request )
{
1.3 +12 -11 jakarta-struts/src/share/org/apache/struts/tiles/ActionController.java
Index: ActionController.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/ActionController.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ActionController.java 5 Jan 2003 01:24:48 -0000 1.2
+++ ActionController.java 27 Feb 2003 19:20:52 -0000 1.3
@@ -71,16 +71,17 @@
import javax.servlet.ServletException;
/**
- * Struts wrapper implementation of Controller.
- * This implementation allows to wrap a Struts Action in a Controller
+ * Struts wrapper implementation of Controller.
+ * This implementation allows to wrap a Struts Action in a Controller.
*/
public class ActionController implements Controller
{
- /** Struts action wrapped */
+ /** Struts action wrapped. */
private Action action;
/**
* Constructor.
+ * @param action Action to be wrapped.
*/
public ActionController( Action action )
{
@@ -88,13 +89,13 @@
}
/**
- * Method associated to a tile and called when immediately before tile is included.
- * This implementation call a Struts Action. No servlet is set by this method.
+ * Method associated to a tile and called immediately before tile is included.
+ * This implementation calls a Struts Action. No servlet is set by this method.
*
* @param tileContext Current tile context.
- * @param request Current request
- * @param response Current response
- * @param servletContext Current servlet context
+ * @param request Current request.
+ * @param response Current response.
+ * @param servletContext Current servlet context.
*/
public void perform(ComponentContext tileContext,
HttpServletRequest request, HttpServletResponse response,
1.8 +5 -5 jakarta-struts/src/share/org/apache/struts/tiles/ActionComponentServlet.java
Index: ActionComponentServlet.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/tiles/ActionComponentServlet.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ActionComponentServlet.java 5 Jan 2003 01:24:48 -0000 1.7
+++ ActionComponentServlet.java 27 Feb 2003 19:20:52 -0000 1.8
@@ -361,7 +361,7 @@
* @param response Current page response
*/
protected void doForward(String uri, HttpServletRequest request, HttpServletResponse response)
- throws IOException, ServletException
+ throws IOException, ServletException
{
// Do we do a forward (original behavior) or an include ?
boolean doInclude = false;
@@ -434,7 +434,7 @@
} // end if
// Do dispatching : search dispatcher, then dispatch
- RequestDispatcher rd = getServletContext().getRequestDispatcher(uri);
+ RequestDispatcher rd = getServletContext().getRequestDispatcher(uri);
if (rd == null)
{ // error
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
---------------------------------------------------------------------
To unsubscribe, e-mail: struts-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: struts-dev-help@jakarta.apache.org