Skip to content

Commit 0ca03f1

Browse files
committed
Fix javadoc for module "files"
See #396.
1 parent 239a3de commit 0ca03f1

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

metafacture-files/src/main/java/org/metafacture/files/FileDigestCalculator.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,21 @@ public final class FileDigestCalculator extends
5656
private final DigestAlgorithm algorithm;
5757
private final MessageDigest messageDigest;
5858

59+
/**
60+
* Uses the given DigestAlgorithm to define the MessageDigest.
61+
*
62+
* @param algorithm the DigestAlgorithm
63+
*/
5964
public FileDigestCalculator(final DigestAlgorithm algorithm) {
6065
this.algorithm = algorithm;
6166
this.messageDigest = this.algorithm.getInstance();
6267
}
6368

69+
/**
70+
* Uses the given name of the algorithm to define the MessageDigest.
71+
*
72+
* @param algorithm the name of the algorithm
73+
*/
6474
public FileDigestCalculator(final String algorithm) {
6575
this.algorithm = DigestAlgorithm.valueOf(algorithm.toUpperCase());
6676
this.messageDigest = this.algorithm.getInstance();
@@ -129,6 +139,12 @@ public enum DigestAlgorithm {
129139
this.identifier = identifier;
130140
}
131141

142+
/**
143+
* Returns a MessageDigest object that implements the specified digest
144+
* algorithm.
145+
*
146+
* @return the MessageDigest
147+
*/
132148
public MessageDigest getInstance() {
133149
try {
134150
return MessageDigest.getInstance(identifier);

0 commit comments

Comments
 (0)