1 files changed, 40 insertions, 23 deletions

diff --git a/libjava/classpath/gnu/javax/crypto/pad/IPad.java b/libjava/classpath/gnu/javax/crypto/pad/IPad.java
index 4b4c925e622..0e3db7db19e 100644
--- a/libjava/classpath/gnu/javax/crypto/pad/IPad.java
+++ b/libjava/classpath/gnu/javax/crypto/pad/IPad.java
@@ -38,29 +38,32 @@ exception statement from your version.  */
 
 package gnu.javax.crypto.pad;
 
+import java.util.Map;
+
 /**
- * <p>The basic visible methods of any padding algorithm.</p>
- *
- * <p>Padding algorithms serve to <i>pad</i> and <i>unpad</i> byte arrays usually
+ * The basic visible methods, and attribute names, of every padding algorithm.
+ * <p>
+ * Padding algorithms serve to <i>pad</i> and <i>unpad</i> byte arrays usually
  * as the last step in an <i>encryption</i> or respectively a <i>decryption</i>
  * operation. Their input buffers are usually those processed by instances of
- * {@link gnu.crypto.mode.IMode} and/or {@link gnu.crypto.cipher.IBlockCipher}.</p>
+ * {@link gnu.javax.crypto.mode.IMode} and/or
+ * {@link gnu.javax.crypto.cipher.IBlockCipher}.
  */
 public interface IPad
 {
-
-  // Constants
-  // -------------------------------------------------------------------------
-
-  // Methods
-  // -------------------------------------------------------------------------
+  /**
+   * Property name of the block size in which to operate the padding algorithm.
+   * The value associated with this property name is taken to be a positive 
+   * {@link Integer} greater than zero.
+   */
+  String PADDING_BLOCK_SIZE = "gnu.crypto.pad.block.size";
 
   /** @return the canonical name of this instance. */
   String name();
 
   /**
    * Initialises the padding scheme with a designated block size.
-   *
+   * 
    * @param bs the designated block size.
    * @exception IllegalStateException if the instance is already initialised.
    * @exception IllegalArgumentException if the block size value is invalid.
@@ -68,29 +71,43 @@ public interface IPad
   void init(int bs) throws IllegalStateException;
 
   /**
+   * Initialises the algorithm with designated attributes. Names, valid and/or
+   * recognisable by all concrete implementations are described in the class
+   * documentation above. Other algorithm-specific attributes MUST be documented
+   * in the implementation class of that padding algorithm.
+   * 
+   * @param attributes a set of name-value pairs that describes the desired
+   *          future behaviour of this instance.
+   * @exception IllegalStateException if the instance is already initialised.
+   * @exception IllegalArgumentException if the block size value is invalid.
+   */
+  void init(Map attributes) throws IllegalStateException;
+
+  /**
    * Returns the byte sequence that should be appended to the designated input.
-   *
+   * 
    * @param in the input buffer containing the bytes to pad.
    * @param offset the starting index of meaningful data in <i>in</i>.
    * @param length the number of meaningful bytes in <i>in</i>.
    * @return the possibly 0-byte long sequence to be appended to the designated
-   * input.
+   *         input.
    */
   byte[] pad(byte[] in, int offset, int length);
 
   /**
    * Returns the number of bytes to discard from a designated input buffer.
-   *
+   * 
    * @param in the input buffer containing the bytes to unpad.
    * @param offset the starting index of meaningful data in <i>in</i>.
    * @param length the number of meaningful bytes in <i>in</i>.
    * @return the number of bytes to discard, to the left of index position
-   * <tt>offset + length</tt> in <i>in</i>. In other words, if the return
-   * value of a successful invocation of this method is <tt>result</tt>, then
-   * the unpadded byte sequence will be <tt>offset + length - result</tt> bytes
-   * in <i>in</i>, starting from index position <tt>offset</tt>.
+   *         <code>offset + length</code> in <i>in</i>. In other words, if
+   *         the return value of a successful invocation of this method is
+   *         <code>result</code>, then the unpadded byte sequence will be
+   *         <code>offset + length - result</code> bytes in <i>in</i>,
+   *         starting from index position <code>offset</code>.
    * @exception WrongPaddingException if the data is not terminated with the
-   * expected padding bytes.
+   *              expected padding bytes.
    */
   int unpad(byte[] in, int offset, int length) throws WrongPaddingException;
 
@@ -102,9 +119,9 @@ public interface IPad
 
   /**
    * A basic symmetric pad/unpad test.
-   *
-   * @return <tt>true</tt> if the implementation passes a basic symmetric
-   * self-test. Returns <tt>false</tt> otherwise.
+   * 
+   * @return <code>true</code> if the implementation passes a basic symmetric
+   *         self-test. Returns <code>false</code> otherwise.
    */
   boolean selfTest();
-}
\ No newline at end of file
+}