svn commit: r1026683 - in /shiro/trunk/core/src/main/java/org/apache/shiro: authc/credential/HashedCredentialsMatcher.java crypto/hash/Hash.java

[lh...@apache.org]

Author: lhazlewood
Date: Sat Oct 23 21:39:57 2010
New Revision: 1026683

URL: http://svn.apache.org/viewvc?rev=1026683&view=rev
Log:
SHIRO-204: minor JavaDoc update

Modified:
    shiro/trunk/core/src/main/java/org/apache/shiro/authc/credential/HashedCredentialsMatcher.java
    shiro/trunk/core/src/main/java/org/apache/shiro/crypto/hash/Hash.java

Modified: shiro/trunk/core/src/main/java/org/apache/shiro/authc/credential/HashedCredentialsMatcher.java
URL: http://svn.apache.org/viewvc/shiro/trunk/core/src/main/java/org/apache/shiro/authc/credential/HashedCredentialsMatcher.java?rev=1026683&r1=1026682&r2=1026683&view=diff
==============================================================================
--- shiro/trunk/core/src/main/java/org/apache/shiro/authc/credential/HashedCredentialsMatcher.java (original)
+++ shiro/trunk/core/src/main/java/org/apache/shiro/authc/credential/HashedCredentialsMatcher.java Sat Oct 23 21:39:57 2010
@@ -129,7 +129,8 @@ public class HashedCredentialsMatcher ex
 
     /**
      * JavaBeans-compatibile no-arg constructor intended for use in IoC/Dependency Injection environments.  If you
-     * use this constructor, you <em>MUST</em> set the hash algorithm name
+     * use this constructor, you <em>MUST</em> also additionally set the
+     * {@link #setHashAlgorithmName(String) hashAlgorithmName} property.
      */
     public HashedCredentialsMatcher() {
         this.hashAlgorithm = null;

Modified: shiro/trunk/core/src/main/java/org/apache/shiro/crypto/hash/Hash.java
URL: http://svn.apache.org/viewvc/shiro/trunk/core/src/main/java/org/apache/shiro/crypto/hash/Hash.java?rev=1026683&r1=1026682&r2=1026683&view=diff
==============================================================================
--- shiro/trunk/core/src/main/java/org/apache/shiro/crypto/hash/Hash.java (original)
+++ shiro/trunk/core/src/main/java/org/apache/shiro/crypto/hash/Hash.java Sat Oct 23 21:39:57 2010
@@ -40,9 +40,11 @@ import org.apache.shiro.util.ByteSource;
 public interface Hash extends ByteSource {
 
     /**
-     * Returns the hash algorithm name, for example, {@code SHA-256}, {@code MD5}, etc.
+     * Returns the name of the algorithm used to hash the input source, for example, {@code SHA-256}, {@code MD5}, etc.
+     * <p/>
+     * The name is expected to be a {@link java.security.MessageDigest MessageDigest} algorithm name.
      *
-     * @return the hash algorithm name, for example, {@code SHA-256}, {@code MD5}, etc.
+     * @return the the name of the algorithm used to hash the input source, for example, {@code SHA-256}, {@code MD5}, etc.
      * @since 1.1
      */
     String getAlgorithmName();