[Gridarta-commit] SF.net SVN: gridarta:[9728] trunk/src/utils/src/main/java/net/sf/gridarta/ utils/ActionBuilderUtils.java

[<aki...@us...>]

Revision: 9728
          http://sourceforge.net/p/gridarta/code/9728
Author:   akirschbaum
Date:     2014-12-07 10:50:32 +0000 (Sun, 07 Dec 2014)
Log Message:
-----------
Add comments.

Modified Paths:
--------------
    trunk/src/utils/src/main/java/net/sf/gridarta/utils/ActionBuilderUtils.java

Modified: trunk/src/utils/src/main/java/net/sf/gridarta/utils/ActionBuilderUtils.java
===================================================================
--- trunk/src/utils/src/main/java/net/sf/gridarta/utils/ActionBuilderUtils.java	2014-12-07 10:06:19 UTC (rev 9727)
+++ trunk/src/utils/src/main/java/net/sf/gridarta/utils/ActionBuilderUtils.java	2014-12-07 10:50:32 UTC (rev 9728)
@@ -40,7 +40,8 @@
      * Returns the value of a key as a {@code boolean}.
      * @param actionBuilder the action builder to query
      * @param key the key to query
-     * @return the value
+     * @return the value or {@code false} if the key does not exist or if the
+     * value is invalid
      */
     public static boolean getBoolean(@NotNull final ActionBuilder actionBuilder, @NotNull final String key) {
         final String value = actionBuilder.getString(key);
@@ -82,6 +83,7 @@
      * @param actionBuilder the action builder to query
      * @param key the key to query
      * @return the value
+     * @throws MissingResourceException if the key does not exist
      */
     @NotNull
     public static String getString(@NotNull final ActionBuilder actionBuilder, @NotNull final String key) {
@@ -98,6 +100,7 @@
      * @param key the key to query
      * @param args the arguments to replace in the format string
      * @return the value
+     * @throws MissingResourceException if the key does not exist
      */
     @NotNull
     public static String format(@NotNull final ActionBuilder actionBuilder, @NotNull final String key, @NotNull final Object... args) {
@@ -113,6 +116,7 @@
      * @param actionBuilder the action builder to query
      * @param key the resource key
      * @return the label
+     * @throws MissingResourceException if the key does not exist
      * @noinspection TypeMayBeWeakened
      */
     @NotNull

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.