You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by jk...@apache.org on 2005/09/03 18:48:38 UTC

svn commit: r267482 - /jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/resource/ResourceHelper.java

Author: jkeyes
Date: Sat Sep  3 09:48:32 2005
New Revision: 267482

URL: http://svn.apache.org/viewcvs?rev=267482&view=rev
Log:
- tidied javadoc

Modified:
    jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/resource/ResourceHelper.java

Modified: jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/resource/ResourceHelper.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/resource/ResourceHelper.java?rev=267482&r1=267481&r2=267482&view=diff
==============================================================================
--- jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/resource/ResourceHelper.java (original)
+++ jakarta/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/resource/ResourceHelper.java Sat Sep  3 09:48:32 2005
@@ -1,5 +1,5 @@
-/**
- * Copyright 2003-2004 The Apache Software Foundation
+/*
+ * Copyright 2003-2005 The Apache Software Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@
 
 /**
  * A utility class used to provide internationalisation support.
+ *
  * @author John Keyes
  */
 public class ResourceHelper {
@@ -53,8 +54,7 @@
     /**
      * Create a new ResourceHelper for the specified class.
      * 
-     * @param clazz
-     *            the Class that requires some resources
+     * @param clazz the Class that requires some resources
      */
     private ResourceHelper(final Class clazz) {
 
@@ -83,44 +83,30 @@
     /**
      * Returns the message for the specified key.
      * 
-     * @param key
-     *            the unique identifier of the message
-     * 
+     * @param key the unique identifier of the message
      * @return String the formatted String
      */
     public String getMessage(final String key) {
-        return getMessage(key, new Object[] {
-        });
+        return getMessage(key, new Object[] {});
     }
 
     /**
      * Returns the message for the specified key and argument.
      * 
-     * @param key
-     *            the unique identifier of the message
-     * 
-     * @param value
-     *            the argument value
-     * 
+     * @param key the unique identifier of the message
+     * @param value the argument value
      * @return String the formatted String
      */
     public String getMessage(final String key, final Object value) {
-
         return getMessage(key, new Object[] { value });
     }
 
     /**
      * Returns the message for the specified key and arguments.
      * 
-     * @param key
-     *            the unique identifier of the message
-     * 
-     * @param value1
-     *            an argument value
-     * 
-     * @param value2
-     *            an argument value
-     * 
+     * @param key the unique identifier of the message
+     * @param value1 an argument value
+     * @param value2 an argument value
      * @return String the formatted String
      */
     public String getMessage(
@@ -134,17 +120,10 @@
     /**
      * Returns the message for the specified key and arguments.
      * 
-     * @param key
-     *            the unique identifier of the message
-     * 
-     * @param value1
-     *            an argument value
-     * 
-     * @param value2
-     *            an argument value
-     * 
-     * @param value3
-     *            an argument value
+     * @param key the unique identifier of the message
+     * @param value1 an argument value
+     * @param value2 an argument value
+     * @param value3 an argument value
      * 
      * @return String the formatted String
      */
@@ -160,16 +139,11 @@
     /**
      * Returns the message for the specified key and arguments.
      * 
-     * @param key
-     *            the unique identifier of the message
-     * 
-     * @param values
-     *            argument values
-     * 
+     * @param key the unique identifier of the message
+     * @param values argument values
      * @return String the formatted String
      */
     public String getMessage(final String key, final Object[] values) {
-
         final String msgFormatStr = bundle.getString(key);
         final MessageFormat msgFormat = new MessageFormat(msgFormatStr);
 



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org