JavaDoc

Author: dghgit

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

@@ -1,5 +1,8 @@
 package org.bouncycastle.util;
 
+/**
+ * Utility methods for processing String objects containing IP addresses.
+ */
 public class IPAddress
 {
     /**

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

@@ -1,5 +1,8 @@
 package org.bouncycastle.util;
 
+/**
+ * Utility methods for ints.
+ */
 public class Integers
 {
     public static int rotateLeft(int i, int distance)

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

@@ -1,5 +1,9 @@
 package org.bouncycastle.util;
 
+/**
+ * Interface for Memoable objects. Memoable objects allow the taking of a snapshot of their internal state
+ * via the copy() method and then reseting the object back to that state later using the reset() method.
+ */
 public interface Memoable
 {
     /**
@@ -8,7 +12,7 @@ public interface Memoable
      * The returned object may be used simply to store the state, or may be used as a similar object
      * starting from the copied state.
      */
-    public Memoable copy();
+    Memoable copy();
 
     /**
      * Restore a copied object state into this object.
@@ -19,5 +23,5 @@ public interface Memoable
      * @throws ClassCastException if the provided object is not of the correct type.
      * @throws MemoableResetException if the <b>other</b> parameter is in some other way invalid.
      */
-    public void reset(Memoable other);
+    void reset(Memoable other);
 }

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

@@ -1,5 +1,8 @@
 package org.bouncycastle.util;
 
+/**
+ * Utility methods for converting byte arrays into ints and longs, and back again.
+ */
 public abstract class Pack
 {
     public static int bigEndianToInt(byte[] bs, int off)

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

@@ -1,8 +1,19 @@
 package org.bouncycastle.util;
 
+/**
+ * Interface a selector from a store should conform to.
+ *
+ * @param <T> the type stored in the store.
+ */
 public interface Selector<T>
     extends Cloneable
 {
+    /**
+     * Match the passed in object, returning true if it would be selected by this selector, false otherwise.
+     *
+     * @param obj the object to be matched.
+     * @return true if the object is a match for this selector, false otherwise.
+     */
     boolean match(T obj);
 
     Object clone();

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

@@ -2,8 +2,21 @@
 
 import java.util.Collection;
 
+/**
+ * A generic interface describing a simple store of objects.
+ *
+ * @param <T> the object type stored.
+ */
 public interface Store<T>
 {
+    /**
+     * Return a possibly empty collection of objects that match the criteria implemented
+     * in the passed in Selector.
+     *
+     * @param selector the selector defining the match criteria.
+     * @return a collection of matching objects, empty if none available.
+     * @throws StoreException if there is a failure during matching.
+     */
     Collection<T> getMatches(Selector<T> selector)
         throws StoreException;
 }

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

@@ -1,14 +1,23 @@
 package org.bouncycastle.util;
 
+/**
+ * Exception thrown if there's an issue doing a match in store.
+ */
 public class StoreException
     extends RuntimeException
 {
     private Throwable _e;
 
-    public StoreException(String s, Throwable e)
+    /**
+     * Basic Constructor.
+     *
+     * @param msg message to be associated with this exception.
+     * @param cause the throwable that caused this exception to be raised.
+     */
+    public StoreException(String msg, Throwable cause)
     {
-        super(s);
-        _e = e;
+        super(msg);
+        _e = cause;
     }
 
     public Throwable getCause()

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

@@ -1,14 +1,34 @@
 package org.bouncycastle.util;
 
+/**
+ * An interface defining a list of strings.
+ */
 public interface StringList
     extends Iterable<String>
 {
+    /**
+     * Add a String to the list.
+     *
+     * @param s the String to add.
+     * @return true
+     */
     boolean add(String s);
 
+    /**
+     * Get the string at index index.
+     *
+     * @param index the index position of the String of interest.
+     * @return the String at position index.
+     */
     String get(int index);
 
     int size();
 
+    /**
+     * Return the contents of the list as an array.
+     *
+     * @return an array of String.
+     */
     String[] toStringArray();
 
     /**

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

@@ -8,6 +8,9 @@
 import java.util.ArrayList;
 import java.util.Vector;
 
+/**
+ * String utilities.
+ */
 public final class Strings
 {
     private static String LINE_SEPARATOR;