OSDN Git Service

2006-08-14 Mark Wielaard <mark@klomp.org>
[pf3gnuchains/gcc-fork.git] / libjava / classpath / gnu / java / security / hash / IMessageDigest.java
index b3d7f69..2c5bdd4 100644 (file)
@@ -39,64 +39,56 @@ exception statement from your version.  */
 package gnu.java.security.hash;
 
 /**
- * <p>The basic visible methods of any hash algorithm.</p>
- *
- * <p>A hash (or message digest) algorithm produces its output by iterating a
- * basic compression function on blocks of data.</p>
+ * The basic visible methods of any hash algorithm.
+ * <p>
+ * A hash (or message digest) algorithm produces its output by iterating a basic
+ * compression function on blocks of data.
  */
-public interface IMessageDigest extends Cloneable
+public interface IMessageDigest
+    extends Cloneable
 {
-
-  // Constants
-  // -------------------------------------------------------------------------
-
-  // Methods
-  // -------------------------------------------------------------------------
-
   /**
-   * <p>Returns the canonical name of this algorithm.</p>
-   *
+   * Returns the canonical name of this algorithm.
+   * 
    * @return the canonical name of this instance.
    */
   String name();
 
   /**
-   * <p>Returns the output length in bytes of this message digest algorithm.</p>
-   *
+   * Returns the output length in bytes of this message digest algorithm.
+   * 
    * @return the output length in bytes of this message digest algorithm.
    */
   int hashSize();
 
   /**
-   * <p>Returns the algorithm's (inner) block size in bytes.</p>
-   *
+   * Returns the algorithm's (inner) block size in bytes.
+   * 
    * @return the algorithm's inner block size in bytes.
    */
   int blockSize();
 
   /**
-   * <p>Continues a message digest operation using the input byte.</p>
-   *
+   * Continues a message digest operation using the input byte.
+   * 
    * @param b the input byte to digest.
    */
   void update(byte b);
 
   /**
-   * <p>Continues a message digest operation, by filling the buffer, processing
+   * Continues a message digest operation, by filling the buffer, processing
    * data in the algorithm's HASH_SIZE-bit block(s), updating the context and
-   * count, and buffering the remaining bytes in buffer for the next
-   * operation.</p>
-   *
+   * count, and buffering the remaining bytes in buffer for the next operation.
+   * 
    * @param in the input block.
    */
   void update(byte[] in);
 
   /**
-   * <p>Continues a message digest operation, by filling the buffer, processing
+   * Continues a message digest operation, by filling the buffer, processing
    * data in the algorithm's HASH_SIZE-bit block(s), updating the context and
-   * count, and buffering the remaining bytes in buffer for the next
-   * operation.</p>
-   *
+   * count, and buffering the remaining bytes in buffer for the next operation.
+   * 
    * @param in the input block.
    * @param offset start of meaningful bytes in input block.
    * @param length number of bytes, in input block, to consider.
@@ -104,31 +96,31 @@ public interface IMessageDigest extends Cloneable
   void update(byte[] in, int offset, int length);
 
   /**
-   * <p>Completes the message digest by performing final operations such as
-   * padding and resetting the instance.</p>
-   *
+   * Completes the message digest by performing final operations such as padding
+   * and resetting the instance.
+   * 
    * @return the array of bytes representing the hash value.
    */
   byte[] digest();
 
   /**
-   * <p>Resets the current context of this instance clearing any eventually cached
-   * intermediary values.</p>
+   * Resets the current context of this instance clearing any eventually cached
+   * intermediary values.
    */
   void reset();
 
   /**
-   * <p>A basic test. Ensures that the digest of a pre-determined message is equal
-   * to a known pre-computed value.</p>
-   *
-   * @return <tt>true</tt> if the implementation passes a basic self-test.
-   * Returns <tt>false</tt> otherwise.
+   * A basic test. Ensures that the digest of a pre-determined message is equal
+   * to a known pre-computed value.
+   * 
+   * @return <code>true</code> if the implementation passes a basic self-test.
+   *         Returns <code>false</code> otherwise.
    */
   boolean selfTest();
 
   /**
-   * <p>Returns a clone copy of this instance.</p>
-   *
+   * Returns a clone copy of this instance.
+   * 
    * @return a clone copy of this instance.
    */
   Object clone();