JavaDoc.

Author: dghgit

core/src/main/java/org/bouncycastle/util/Properties.java

@@ -13,7 +13,9 @@
 import java.util.StringTokenizer;
 
 /**
- * Utility method for accessing system properties.
+ * Utility method for accessing properties values - properties can be set in java.security,
+ * thread local, and system properties. They are checked for in the same order with
+ * checking stopped as soon as a value is found.
  */
 public class Properties
 {
@@ -115,6 +117,13 @@ public static boolean removeThreadOverride(String propertyName)
         return false;
     }
 
+    /**
+     * Return propertyName as an integer, defaultValue used if not defined.
+     *
+     * @param propertyName name of property.
+     * @param defaultValue integer to return if property not defined.
+     * @return value of property, or default if not found, as an int.
+     */
     public static int asInteger(String propertyName, int defaultValue)
     {
         String p = getPropertyValue(propertyName);
@@ -127,6 +136,12 @@ public static int asInteger(String propertyName, int defaultValue)
         return defaultValue;
     }
 
+    /**
+     * Return propertyName as a BigInteger.
+     *
+     * @param propertyName name of property.
+     * @return value of property as a BigInteger, null if not defined.
+     */
     public static BigInteger asBigInteger(String propertyName)
     {
         String p = getPropertyValue(propertyName);
@@ -157,6 +172,13 @@ public static Set<String> asKeySet(String propertyName)
         return Collections.unmodifiableSet(set);
     }
 
+    /**
+     * Return the String value of the property propertyName. Property valuation
+     * starts with java.security, then thread local, then system properties.
+     *
+     * @param propertyName name of property.
+     * @return value of property as a String, null if not defined.
+     */
     public static String getPropertyValue(final String propertyName)
     {
         String val = (String)AccessController.doPrivileged(new PrivilegedAction()