You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by mp...@apache.org on 2001/11/24 19:32:40 UTC

cvs commit: jakarta-turbine-fulcrum/src/core/java/org/apache/fulcrum BaseService.java

mpoeschl    01/11/24 10:32:40

  Modified:    src/services/java/org/apache/fulcrum/upload
                        UploadService.java TurbineUpload.java
               src/services/java/org/apache/fulcrum/localization
                        LocalizationService.java Localization.java
               src/core/java/org/apache/fulcrum BaseService.java
  Log:
  fix javadoc warnings
  
  Revision  Changes    Path
  1.5       +4 -5      jakarta-turbine-fulcrum/src/services/java/org/apache/fulcrum/upload/UploadService.java
  
  Index: UploadService.java
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-fulcrum/src/services/java/org/apache/fulcrum/upload/UploadService.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- UploadService.java	2001/10/31 00:56:34	1.4
  +++ UploadService.java	2001/11/24 18:32:40	1.5
  @@ -68,7 +68,7 @@
    *
    * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
    * @author <a href="mailto:dlr@collab.net">Daniel Rall</a>
  - * @version $Id: UploadService.java,v 1.4 2001/10/31 00:56:34 mpoeschl Exp $
  + * @version $Id: UploadService.java,v 1.5 2001/11/24 18:32:40 mpoeschl Exp $
    */
   public interface UploadService
       extends Service
  @@ -127,8 +127,8 @@
        * multipart request will be performed automaticaly by {@link
        * org.apache.fulcrum.util.parser.ParameterParser}.  Otherwise, an {@link
        * org.apache.turbine.modules.Action} may decide to to parse the
  -     * request by calling {@link #parseRequest(HttpServletRequest,
  -     * ParameterParser, String) parseRequest} manually.
  +     * request by calling {@link #parseRequest(HttpServletRequest, String)
  +     * parseRequest} manually.
        */
       public static final boolean AUTOMATIC_DEFAULT = false;
   
  @@ -194,8 +194,7 @@
        * the request or storing files.
        */
       public ArrayList parseRequest( HttpServletRequest req, String path )
  -
  -throws ServiceException;
  +            throws ServiceException;
   
       /**
        * <p> Retrieves the value of <code>size.max</code> property of the
  
  
  
  1.3       +3 -3      jakarta-turbine-fulcrum/src/services/java/org/apache/fulcrum/upload/TurbineUpload.java
  
  Index: TurbineUpload.java
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-fulcrum/src/services/java/org/apache/fulcrum/upload/TurbineUpload.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- TurbineUpload.java	2001/08/10 11:46:24	1.2
  +++ TurbineUpload.java	2001/11/24 18:32:40	1.3
  @@ -70,7 +70,7 @@
    * the service's properties and default values for them.
    *
    * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
  - * @version $Id: TurbineUpload.java,v 1.2 2001/08/10 11:46:24 knielsen Exp $
  + * @version $Id: TurbineUpload.java,v 1.3 2001/11/24 18:32:40 mpoeschl Exp $
    */
   public abstract class TurbineUpload
   {
  @@ -150,8 +150,8 @@
       /**
        * <p> Performs parsing the request and storing files and form
        * fields.  Default file repository is used.  This method is
  -     * called by the {@link ParameterParser} if automatic upload is
  -     * enabled.
  +     * called by the {@link org.apache.fulcrum.util.parser.ParameterParser} if
  +     * automatic upload is enabled.
        *
        * @param req The servlet request to be parsed.
        * @param params The ParameterParser instance to insert form
  
  
  
  1.9       +6 -6      jakarta-turbine-fulcrum/src/services/java/org/apache/fulcrum/localization/LocalizationService.java
  
  Index: LocalizationService.java
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-fulcrum/src/services/java/org/apache/fulcrum/localization/LocalizationService.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- LocalizationService.java	2001/11/10 00:01:21	1.8
  +++ LocalizationService.java	2001/11/24 18:32:40	1.9
  @@ -71,7 +71,7 @@
    * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
    * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
    * @author <a href="mailto:leonardr@collab.net">Leonard Richardson</a>
  - * @version $Id: LocalizationService.java,v 1.8 2001/11/10 00:01:21 dlr Exp $
  + * @version $Id: LocalizationService.java,v 1.9 2001/11/24 18:32:40 mpoeschl Exp $
    */
   public interface LocalizationService
       extends Service
  @@ -223,9 +223,9 @@
        * @param key The identifier for the localized text to retrieve,
        * @param arg1 The object to use as {0} when formatting the localized text.
        * @return Formatted localized text.
  -     * @see #format(String, Object[])
  +     * @see #format(String, Locale, String, Object[])
        */
  -    public String format(String bundleName, Locale locale, 
  +    public String format(String bundleName, Locale locale,
                            String key, Object arg1);
   
       /**
  @@ -237,9 +237,9 @@
        * @param arg1 The object to use as {0} when formatting the localized text.
        * @param arg2 The object to use as {1} when formatting the localized text.
        * @return Formatted localized text.
  -     * @see #format(String, Object[])
  +     * @see #format(String, Locale, String, Object[])
        */
  -    public String format(String bundleName, Locale locale, 
  +    public String format(String bundleName, Locale locale,
                            String key, Object arg1, Object arg2);
   
       /**
  @@ -252,6 +252,6 @@
        *             formatting the localized text.
        * @return Formatted localized text.
        */
  -    public String format(String bundleName, Locale locale, 
  +    public String format(String bundleName, Locale locale,
                            String key, Object[] args);
   }
  
  
  
  1.15      +16 -10    jakarta-turbine-fulcrum/src/services/java/org/apache/fulcrum/localization/Localization.java
  
  Index: Localization.java
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-fulcrum/src/services/java/org/apache/fulcrum/localization/Localization.java,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- Localization.java	2001/11/10 00:03:03	1.14
  +++ Localization.java	2001/11/24 18:32:40	1.15
  @@ -84,7 +84,7 @@
    * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
    * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
    * @author <a href="mailto:leonardr@collab.net">Leonard Richardson</a>
  - * @version $Id: Localization.java,v 1.14 2001/11/10 00:03:03 dlr Exp $
  + * @version $Id: Localization.java,v 1.15 2001/11/24 18:32:40 mpoeschl Exp $
    */
   public abstract class Localization
   {
  @@ -105,7 +105,7 @@
       }
   
       /**
  -     * @see org.apache.fulcrum.localization.LocalizationService#getString(String, Locale, String)
  +     * @see LocalizationService#getString(String, Locale, String)
        */
       public static String getString(Locale locale, String key)
       {
  @@ -116,7 +116,7 @@
        * Fetches the localized text from the specified bundle, ignoring
        * any default bundles.
        *
  -     * @see org.apache.fulcrum.localization.LocalizationService#getString(String, Locale, String)
  +     * @see LocalizationService#getString(String, Locale, String)
        */
       public static String getString(String bundleName, Locale locale,
                                      String key)
  @@ -125,7 +125,13 @@
       }
   
       /**
  -     * @see org.apache.fulcrum.localization.LocalizationService#getString(HttpServletRequest, String)
  +     * Convenience method that pulls a localized string off the
  +     * LocalizationService using the ResourceBundle based on HTTP
  +     * Accept-Language header in HttpServletRequest.
  +     *
  +     * @param req The HTTP request to parse the <code>Accept-Language</code> of.
  +     * @param key Name of string.
  +     * @return A localized string.
        */
       public static String getString(HttpServletRequest req, String key)
       {
  @@ -216,7 +222,7 @@
        * This method sets the name of the default bundle.
        *
        * @param defaultBundle Name of default bundle.
  -     * @see org.apache.fulcrum.localization.LocalizationService#setBundle(String)
  +     * @see LocalizationService#setBundle(String)
        */
       public static void setBundle(String defaultBundle)
       {
  @@ -224,7 +230,7 @@
       }
   
       /**
  -     * @see org.apache.fulcrum.localization.LocalizationService#getLocale(HttpServletRequest)
  +     * @see LocalizationService#getLocale(HttpServletRequest)
        */
       public static Locale getLocale(HttpServletRequest req)
       {
  @@ -244,7 +250,7 @@
       }
   
       /**
  -     * @see org.apache.fulcrum.localization.LocalizationService#getDefaultBundleName()
  +     * @see LocalizationService#getDefaultBundleName()
        */
       public static String getDefaultBundleName()
       {
  @@ -263,7 +269,7 @@
       }
   
       /**
  -     * @see org.apache.fulcrum.localization.LocalizationServie#format(String, Locale, String, Object)
  +     * @see LocalizationService#format(String, Locale, String, Object)
        */
       public static String format(String bundleName, Locale locale,
                                   String key, Object arg1)
  @@ -272,7 +278,7 @@
       }
   
       /**
  -     * @see org.apache.fulcrum.localization.LocalizationServie#format(String, Locale, String, Object, Object)
  +     * @see LocalizationService#format(String, Locale, String, Object, Object)
        */
       public static String format(String bundleName, Locale locale,
                                   String key, Object arg1, Object arg2)
  @@ -281,7 +287,7 @@
       }
   
       /**
  -     * @see org.apache.fulcrum.localization.LocalizationServie#format(String, Locale, String, Object[])
  +     * @see LocalizationService#format(String, Locale, String, Object[])
        */
       public static String format(String bundleName, Locale locale,
                                   String key, Object[] args)
  
  
  
  1.9       +3 -4      jakarta-turbine-fulcrum/src/core/java/org/apache/fulcrum/BaseService.java
  
  Index: BaseService.java
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-fulcrum/src/core/java/org/apache/fulcrum/BaseService.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- BaseService.java	2001/08/31 08:00:28	1.8
  +++ BaseService.java	2001/11/24 18:32:40	1.9
  @@ -68,7 +68,7 @@
    * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
    * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
    * @author <a href="mailto:leonardr@segfault.org">Leonard Richardson</a>
  - * @version $Id: BaseService.java,v 1.8 2001/08/31 08:00:28 jvanzyl Exp $
  + * @version $Id: BaseService.java,v 1.9 2001/11/24 18:32:40 mpoeschl Exp $
    */
   public abstract class BaseService
       implements Service
  @@ -126,7 +126,6 @@
        * Returns initialization status.
        *
        * @return True if the service is initialized.
  -     * @see org.apache.fulcrum.Service#getInit()
        * @see org.apache.fulcrum.Service#isInitialized()
        * @deprecated use isInitialized() which uses proper bean semantics.
        */
  @@ -229,7 +228,7 @@
       }
   
       /**
  -     * @see org.apache.fulcrum.ServiceBroker#getServiceObject()
  +     * @see org.apache.fulcrum.ServiceBroker#getServiceObject(String)
        */
       public Object getServiceObject(String name)
       {
  @@ -237,7 +236,7 @@
       }
   
       /**
  -     * @see org.apache.fulcrum.Service#getRealPath()
  +     * @see org.apache.fulcrum.ServiceBroker#getRealPath(String)
        */
       public String getRealPath(String path)
       {
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>