Skip to content

Commit 46bef82

Browse files
rickymamichael-o
rickyma
authored and
michael-o
committed
[CODEC-292] Misspelling in comments 'They' -> 'The'
1 parent 2850035 commit 46bef82

1 file changed

Lines changed: 37 additions & 37 deletions

File tree

‎src/main/java/org/apache/commons/codec/digest/HmacUtils.java‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public static boolean isAvailable(final HmacAlgorithms name) {
9696
* </p>
9797
*
9898
* @param key
99-
* They key for the keyed digest (must not be null)
99+
* The key for the keyed digest (must not be null)
100100
* @return A Mac instance initialized with the given key.
101101
* @see Mac#getInstance(String)
102102
* @see Mac#init(Key)
@@ -116,7 +116,7 @@ public static Mac getHmacMd5(final byte[] key) {
116116
* </p>
117117
*
118118
* @param key
119-
* They key for the keyed digest (must not be null)
119+
* The key for the keyed digest (must not be null)
120120
* @return A Mac instance initialized with the given key.
121121
* @see Mac#getInstance(String)
122122
* @see Mac#init(Key)
@@ -136,7 +136,7 @@ public static Mac getHmacSha1(final byte[] key) {
136136
* </p>
137137
*
138138
* @param key
139-
* They key for the keyed digest (must not be null)
139+
* The key for the keyed digest (must not be null)
140140
* @return A Mac instance initialized with the given key.
141141
* @see Mac#getInstance(String)
142142
* @see Mac#init(Key)
@@ -156,7 +156,7 @@ public static Mac getHmacSha256(final byte[] key) {
156156
* </p>
157157
*
158158
* @param key
159-
* They key for the keyed digest (must not be null)
159+
* The key for the keyed digest (must not be null)
160160
* @return A Mac instance initialized with the given key.
161161
* @see Mac#getInstance(String)
162162
* @see Mac#init(Key)
@@ -176,7 +176,7 @@ public static Mac getHmacSha384(final byte[] key) {
176176
* </p>
177177
*
178178
* @param key
179-
* They key for the keyed digest (must not be null)
179+
* The key for the keyed digest (must not be null)
180180
* @return A Mac instance initialized with the given key.
181181
* @see Mac#getInstance(String)
182182
* @see Mac#init(Key)
@@ -198,7 +198,7 @@ public static Mac getHmacSha512(final byte[] key) {
198198
* >Appendix A in the Java Cryptography Architecture Reference Guide</a> for information about standard
199199
* algorithm names.
200200
* @param key
201-
* They key for the keyed digest (must not be null)
201+
* The key for the keyed digest (must not be null)
202202
* @return A Mac instance initialized with the given key.
203203
* @see Mac#getInstance(String)
204204
* @see Mac#init(Key)
@@ -218,7 +218,7 @@ public static Mac getInitializedMac(final HmacAlgorithms algorithm, final byte[]
218218
* >Appendix A in the Java Cryptography Architecture Reference Guide</a> for information about standard
219219
* algorithm names.
220220
* @param key
221-
* They key for the keyed digest (must not be null)
221+
* The key for the keyed digest (must not be null)
222222
* @return A Mac instance initialized with the given key.
223223
* @see Mac#getInstance(String)
224224
* @see Mac#init(Key)
@@ -249,7 +249,7 @@ public static Mac getInitializedMac(final String algorithm, final byte[] key) {
249249
* Returns a HmacMD5 Message Authentication Code (MAC) for the given key and value.
250250
*
251251
* @param key
252-
* They key for the keyed digest (must not be null)
252+
* The key for the keyed digest (must not be null)
253253
* @param valueToDigest
254254
* The value (data) which should to digest (maybe empty or null)
255255
* @return HmacMD5 MAC for the given key and value
@@ -266,7 +266,7 @@ public static byte[] hmacMd5(final byte[] key, final byte[] valueToDigest) {
266266
* Returns a HmacMD5 Message Authentication Code (MAC) for the given key and value.
267267
*
268268
* @param key
269-
* They key for the keyed digest (must not be null)
269+
* The key for the keyed digest (must not be null)
270270
* @param valueToDigest
271271
* The value (data) which should to digest
272272
* <p>
@@ -288,7 +288,7 @@ public static byte[] hmacMd5(final byte[] key, final InputStream valueToDigest)
288288
* Returns a HmacMD5 Message Authentication Code (MAC) for the given key and value.
289289
*
290290
* @param key
291-
* They key for the keyed digest (must not be null)
291+
* The key for the keyed digest (must not be null)
292292
* @param valueToDigest
293293
* The value (data) which should to digest (maybe empty or null)
294294
* @return HmacMD5 MAC for the given key and value
@@ -305,7 +305,7 @@ public static byte[] hmacMd5(final String key, final String valueToDigest) {
305305
* Returns a HmacMD5 Message Authentication Code (MAC) as a hex string (lowercase) for the given key and value.
306306
*
307307
* @param key
308-
* They key for the keyed digest (must not be null)
308+
* The key for the keyed digest (must not be null)
309309
* @param valueToDigest
310310
* The value (data) which should to digest (maybe empty or null)
311311
* @return HmacMD5 MAC for the given key and value as a hex string (lowercase)
@@ -322,7 +322,7 @@ public static String hmacMd5Hex(final byte[] key, final byte[] valueToDigest) {
322322
* Returns a HmacMD5 Message Authentication Code (MAC) as a hex string (lowercase) for the given key and value.
323323
*
324324
* @param key
325-
* They key for the keyed digest (must not be null)
325+
* The key for the keyed digest (must not be null)
326326
* @param valueToDigest
327327
* The value (data) which should to digest
328328
* <p>
@@ -344,7 +344,7 @@ public static String hmacMd5Hex(final byte[] key, final InputStream valueToDiges
344344
* Returns a HmacMD5 Message Authentication Code (MAC) as a hex string (lowercase) for the given key and value.
345345
*
346346
* @param key
347-
* They key for the keyed digest (must not be null)
347+
* The key for the keyed digest (must not be null)
348348
* @param valueToDigest
349349
* The value (data) which should to digest (maybe empty or null)
350350
* @return HmacMD5 MAC for the given key and value as a hex string (lowercase)
@@ -363,7 +363,7 @@ public static String hmacMd5Hex(final String key, final String valueToDigest) {
363363
* Returns a HmacSHA1 Message Authentication Code (MAC) for the given key and value.
364364
*
365365
* @param key
366-
* They key for the keyed digest (must not be null)
366+
* The key for the keyed digest (must not be null)
367367
* @param valueToDigest
368368
* The value (data) which should to digest (maybe empty or null)
369369
* @return HmacSHA1 MAC for the given key and value
@@ -380,7 +380,7 @@ public static byte[] hmacSha1(final byte[] key, final byte[] valueToDigest) {
380380
* Returns a HmacSHA1 Message Authentication Code (MAC) for the given key and value.
381381
*
382382
* @param key
383-
* They key for the keyed digest (must not be null)
383+
* The key for the keyed digest (must not be null)
384384
* @param valueToDigest
385385
* The value (data) which should to digest
386386
* <p>
@@ -402,7 +402,7 @@ public static byte[] hmacSha1(final byte[] key, final InputStream valueToDigest)
402402
* Returns a HmacSHA1 Message Authentication Code (MAC) for the given key and value.
403403
*
404404
* @param key
405-
* They key for the keyed digest (must not be null)
405+
* The key for the keyed digest (must not be null)
406406
* @param valueToDigest
407407
* The value (data) which should to digest (maybe empty or null)
408408
* @return HmacSHA1 MAC for the given key and value
@@ -419,7 +419,7 @@ public static byte[] hmacSha1(final String key, final String valueToDigest) {
419419
* Returns a HmacSHA1 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
420420
*
421421
* @param key
422-
* They key for the keyed digest (must not be null)
422+
* The key for the keyed digest (must not be null)
423423
* @param valueToDigest
424424
* The value (data) which should to digest (maybe empty or null)
425425
* @return HmacSHA1 MAC for the given key and value as hex string (lowercase)
@@ -436,7 +436,7 @@ public static String hmacSha1Hex(final byte[] key, final byte[] valueToDigest) {
436436
* Returns a HmacSHA1 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
437437
*
438438
* @param key
439-
* They key for the keyed digest (must not be null)
439+
* The key for the keyed digest (must not be null)
440440
* @param valueToDigest
441441
* The value (data) which should to digest
442442
* <p>
@@ -458,7 +458,7 @@ public static String hmacSha1Hex(final byte[] key, final InputStream valueToDige
458458
* Returns a HmacSHA1 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
459459
*
460460
* @param key
461-
* They key for the keyed digest (must not be null)
461+
* The key for the keyed digest (must not be null)
462462
* @param valueToDigest
463463
* The value (data) which should to digest (maybe empty or null)
464464
* @return HmacSHA1 MAC for the given key and value as hex string (lowercase)
@@ -477,7 +477,7 @@ public static String hmacSha1Hex(final String key, final String valueToDigest) {
477477
* Returns a HmacSHA256 Message Authentication Code (MAC) for the given key and value.
478478
*
479479
* @param key
480-
* They key for the keyed digest (must not be null)
480+
* The key for the keyed digest (must not be null)
481481
* @param valueToDigest
482482
* The value (data) which should to digest (maybe empty or null)
483483
* @return HmacSHA256 MAC for the given key and value
@@ -494,7 +494,7 @@ public static byte[] hmacSha256(final byte[] key, final byte[] valueToDigest) {
494494
* Returns a HmacSHA256 Message Authentication Code (MAC) for the given key and value.
495495
*
496496
* @param key
497-
* They key for the keyed digest (must not be null)
497+
* The key for the keyed digest (must not be null)
498498
* @param valueToDigest
499499
* The value (data) which should to digest
500500
* <p>
@@ -516,7 +516,7 @@ public static byte[] hmacSha256(final byte[] key, final InputStream valueToDiges
516516
* Returns a HmacSHA256 Message Authentication Code (MAC) for the given key and value.
517517
*
518518
* @param key
519-
* They key for the keyed digest (must not be null)
519+
* The key for the keyed digest (must not be null)
520520
* @param valueToDigest
521521
* The value (data) which should to digest (maybe empty or null)
522522
* @return HmacSHA256 MAC for the given key and value
@@ -533,7 +533,7 @@ public static byte[] hmacSha256(final String key, final String valueToDigest) {
533533
* Returns a HmacSHA256 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
534534
*
535535
* @param key
536-
* They key for the keyed digest (must not be null)
536+
* The key for the keyed digest (must not be null)
537537
* @param valueToDigest
538538
* The value (data) which should to digest (maybe empty or null)
539539
* @return HmacSHA256 MAC for the given key and value as hex string (lowercase)
@@ -550,7 +550,7 @@ public static String hmacSha256Hex(final byte[] key, final byte[] valueToDigest)
550550
* Returns a HmacSHA256 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
551551
*
552552
* @param key
553-
* They key for the keyed digest (must not be null)
553+
* The key for the keyed digest (must not be null)
554554
* @param valueToDigest
555555
* The value (data) which should to digest
556556
* <p>
@@ -572,7 +572,7 @@ public static String hmacSha256Hex(final byte[] key, final InputStream valueToDi
572572
* Returns a HmacSHA256 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
573573
*
574574
* @param key
575-
* They key for the keyed digest (must not be null)
575+
* The key for the keyed digest (must not be null)
576576
* @param valueToDigest
577577
* The value (data) which should to digest (maybe empty or null)
578578
* @return HmacSHA256 MAC for the given key and value as hex string (lowercase)
@@ -591,7 +591,7 @@ public static String hmacSha256Hex(final String key, final String valueToDigest)
591591
* Returns a HmacSHA384 Message Authentication Code (MAC) for the given key and value.
592592
*
593593
* @param key
594-
* They key for the keyed digest (must not be null)
594+
* The key for the keyed digest (must not be null)
595595
* @param valueToDigest
596596
* The value (data) which should to digest (maybe empty or null)
597597
* @return HmacSHA384 MAC for the given key and value
@@ -608,7 +608,7 @@ public static byte[] hmacSha384(final byte[] key, final byte[] valueToDigest) {
608608
* Returns a HmacSHA384 Message Authentication Code (MAC) for the given key and value.
609609
*
610610
* @param key
611-
* They key for the keyed digest (must not be null)
611+
* The key for the keyed digest (must not be null)
612612
* @param valueToDigest
613613
* The value (data) which should to digest
614614
* <p>
@@ -630,7 +630,7 @@ public static byte[] hmacSha384(final byte[] key, final InputStream valueToDiges
630630
* Returns a HmacSHA384 Message Authentication Code (MAC) for the given key and value.
631631
*
632632
* @param key
633-
* They key for the keyed digest (must not be null)
633+
* The key for the keyed digest (must not be null)
634634
* @param valueToDigest
635635
* The value (data) which should to digest (maybe empty or null)
636636
* @return HmacSHA384 MAC for the given key and value
@@ -647,7 +647,7 @@ public static byte[] hmacSha384(final String key, final String valueToDigest) {
647647
* Returns a HmacSHA384 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
648648
*
649649
* @param key
650-
* They key for the keyed digest (must not be null)
650+
* The key for the keyed digest (must not be null)
651651
* @param valueToDigest
652652
* The value (data) which should to digest (maybe empty or null)
653653
* @return HmacSHA384 MAC for the given key and value as hex string (lowercase)
@@ -664,7 +664,7 @@ public static String hmacSha384Hex(final byte[] key, final byte[] valueToDigest)
664664
* Returns a HmacSHA384 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
665665
*
666666
* @param key
667-
* They key for the keyed digest (must not be null)
667+
* The key for the keyed digest (must not be null)
668668
* @param valueToDigest
669669
* The value (data) which should to digest
670670
* <p>
@@ -686,7 +686,7 @@ public static String hmacSha384Hex(final byte[] key, final InputStream valueToDi
686686
* Returns a HmacSHA384 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
687687
*
688688
* @param key
689-
* They key for the keyed digest (must not be null)
689+
* The key for the keyed digest (must not be null)
690690
* @param valueToDigest
691691
* The value (data) which should to digest (maybe empty or null)
692692
* @return HmacSHA384 MAC for the given key and value as hex string (lowercase)
@@ -705,7 +705,7 @@ public static String hmacSha384Hex(final String key, final String valueToDigest)
705705
* Returns a HmacSHA512 Message Authentication Code (MAC) for the given key and value.
706706
*
707707
* @param key
708-
* They key for the keyed digest (must not be null)
708+
* The key for the keyed digest (must not be null)
709709
* @param valueToDigest
710710
* The value (data) which should to digest (maybe empty or null)
711711
* @return HmacSHA512 MAC for the given key and value
@@ -722,7 +722,7 @@ public static byte[] hmacSha512(final byte[] key, final byte[] valueToDigest) {
722722
* Returns a HmacSHA512 Message Authentication Code (MAC) for the given key and value.
723723
*
724724
* @param key
725-
* They key for the keyed digest (must not be null)
725+
* The key for the keyed digest (must not be null)
726726
* @param valueToDigest
727727
* The value (data) which should to digest
728728
* <p>
@@ -744,7 +744,7 @@ public static byte[] hmacSha512(final byte[] key, final InputStream valueToDiges
744744
* Returns a HmacSHA512 Message Authentication Code (MAC) for the given key and value.
745745
*
746746
* @param key
747-
* They key for the keyed digest (must not be null)
747+
* The key for the keyed digest (must not be null)
748748
* @param valueToDigest
749749
* The value (data) which should to digest (maybe empty or null)
750750
* @return HmacSHA512 MAC for the given key and value
@@ -761,7 +761,7 @@ public static byte[] hmacSha512(final String key, final String valueToDigest) {
761761
* Returns a HmacSHA512 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
762762
*
763763
* @param key
764-
* They key for the keyed digest (must not be null)
764+
* The key for the keyed digest (must not be null)
765765
* @param valueToDigest
766766
* The value (data) which should to digest (maybe empty or null)
767767
* @return HmacSHA512 MAC for the given key and value as hex string (lowercase)
@@ -778,7 +778,7 @@ public static String hmacSha512Hex(final byte[] key, final byte[] valueToDigest)
778778
* Returns a HmacSHA512 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
779779
*
780780
* @param key
781-
* They key for the keyed digest (must not be null)
781+
* The key for the keyed digest (must not be null)
782782
* @param valueToDigest
783783
* The value (data) which should to digest
784784
* <p>
@@ -800,7 +800,7 @@ public static String hmacSha512Hex(final byte[] key, final InputStream valueToDi
800800
* Returns a HmacSHA512 Message Authentication Code (MAC) as hex string (lowercase) for the given key and value.
801801
*
802802
* @param key
803-
* They key for the keyed digest (must not be null)
803+
* The key for the keyed digest (must not be null)
804804
* @param valueToDigest
805805
* The value (data) which should to digest (maybe empty or null)
806806
* @return HmacSHA512 MAC for the given key and value as hex string (lowercase)

0 commit comments

Comments
 (0)