Login | Register
My pages Projects Community openCollabNet

Discussions > cvs > CVS update: joist/java/org/joist/util FileUpload.java

Project highlights: Architectural Overview

joist
Discussion topic

Back to topic list

CVS update: joist/java/org/joist/util FileUpload.java

Author dlr
Full name Daniel Rall
Date 2000-11-07 22:23:32 PST
Message User: dlr
  Date: 00/11/07 22:23:32

  Modified: java/org/joist/util FileUpload.java
  Log:
  Cleaned up documentation.
  
  Revision Changes Path
  1.4 +30 -24 joist/java/org/joist​/util/FileUpload.jav​a
  
  Index: FileUpload.java
  ====================​====================​====================​=======
  RCS file: /cvs/joist/java/org/​joist/util/FileUploa​d.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- FileUpload.java 2000/07/05 21:29:29 1.3
  +++ FileUpload.java 2000/11/08 06:23:32 1.4
  @@ -72,7 +72,7 @@
    * </pre>
    *
    * @author <a href="mailto:dlr@col​lab.net">Daniel L. Rall</a>
  - * @version $Id: FileUpload.java,v 1.3 2000/07/05 21:29:29 jeffw Exp $
  + * @version $Id: FileUpload.java,v 1.4 2000/11/08 06:23:32 dlr Exp $
    *
    * Copyright (c) 2000 Collab.Net, Inc.
    */
  @@ -91,17 +91,18 @@
        * <code>REQ_CONT​ENT_TYPE</code​>, attempt to processes it as a file
        * upload.
        *
  - * @param connection JDBC connection--not used by this method. Only here
  - * @param context The WebContext used by this request.
  - * @return The name of the template to use.
  - * @exception HandlerException
  - * @exception RedirectException
  + * @param connection JDBC connection--not used by this method. Only here
        * to implement the interface of UnsecureServlet.
  + * @param context The WebContext used by this request.
  + * @return The name of the template to use.
  + *
  + * @exception HandlerException
  + * @exception RedirectException
        */
       protected String processRequest (Connection connection, WebContext context)
       throws HandlerException, RedirectException
       {
  - if (debug) log.debug("FileUpload: enter");
  + if (debug) log.debug("start");
   
       // Let the superclass do it's part.
       String templateName = super.processRequest​(connection, context);
  @@ -142,17 +143,18 @@
                             + contentType);
               }
           }
  -
  - if (debug) log.debug("FileUpload: exit");
   
  + if (debug) log.debug("done");
       return templateName;
       }
   
       /**
        * Performs the desired save activities.
  - * @param context A variable of type WebContext
  - * @return A variable of type MultipartRequest
  - * @exception IOException
  + *
  + * @param context The context of user interaction.
  + * @return The multipart request.
  + *
  + * @exception IOException
        */
       protected MultipartRequest getMultipartRequest (WebContext context)
       throws IOException
  @@ -162,10 +164,12 @@
   
       /**
        * Performs the desired save activities.
  - * @param context A variable of type WebContext
  - * @param maxPostSize A variable of type int
  - * @return A variable of type MultipartRequest
  - * @exception IOException
  + *
  + * @param context The context of user interaction.
  + * @param maxPostSize The maximum size of the post.
  + * @return The multipart request.
  + *
  + * @exception IOException
        */
       protected MultipartRequest getMultipartRequest (WebContext context,
                               int maxPostSize)
  @@ -178,9 +182,10 @@
   
       /**
        * Sets the file system permissions for the specified files.
  + *
  + * @param files The Vector of File objects to set permissions for.
        *
  - * @param files The Vector of File objects to set permissions for.
  - * @exception JoistException
  + * @exception JoistException
        */
       protected void setFilesystemPermissions (Vector files)
       throws JoistException
  @@ -230,10 +235,11 @@
        * Performs any additional processing that may be desired, then returns
        * the names that the uploaded files were saved as.
        *
  - * @param connection The JDBC connection to use.
  - * @param mreq The MultipartRequest to use.
  - * @param context The WebContext to use.
  - * @return The File objects the uploaded files were saved as.
  + * @param connection The JDBC connection to use.
  + * @param mreq The MultipartRequest to use.
  + * @param context The WebContext to use.
  + * @return The <code>File</code> objects the uploaded files were
  + * saved as.
        */
       protected Vector processUploadedFiles (Connection connection,
                          WebContext context,
  @@ -255,7 +261,7 @@
        * Returns the path of the directory to save the files to initially.
        * Defaults to the system TEMP directory.
        *
  - * @return The path of the directory to save the file to.
  + * @return The path of the directory to save the file to.
        */
       protected String getSaveDirectory ()
       {
  @@ -266,7 +272,7 @@
       /**
        * Returns the file system permissions to set saved files to.
        *
  - * @return The path of the directory to save the file to.
  + * @return The path of the directory to save the file to.
        */
       protected String getFilesystemPermissions ()
       {

« Previous message in topic | 1 of 1 | Next message in topic »

Messages

Show all messages in topic

CVS update: joist/java/org/joist/util FileUpload.java dlr Daniel Rall 2000-11-07 22:23:32 PST
Messages per page: