Skip to content

Commit 768390f

Browse files
committed
Typos aplenty
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1744330 13f79535-47bb-0310-9956-ffa450edef68
1 parent 76a9412 commit 768390f

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

src/main/java/org/apache/commons/codec/digest/HmacAlgorithms.java

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ private HmacAlgorithms(final String algorithm) {
108108
* </p>
109109
*
110110
* @param key
111-
* They key for the keyed digest (must not be null)
111+
* The key for the keyed digest (must not be null)
112112
* @return A Mac instance initialized with the given key.
113113
* @see Mac#getInstance(String)
114114
* @see Mac#init(Key)
@@ -134,9 +134,9 @@ public String getName() {
134134
* Returns a keyed-Hash Message Authentication Code (HMAC) for the given key and value.
135135
*
136136
* @param key
137-
* They key for the keyed digest (must not be null)
137+
* The key for the keyed digest (must not be null)
138138
* @param valueToDigest
139-
* The value (data) which should to digest (maybe empty or null)
139+
* The value (data) to digest (maybe empty or null)
140140
* @return HMAC for the given key and value
141141
* @throws IllegalArgumentException
142142
* when a {@link NoSuchAlgorithmException} is caught or key is null or key is invalid.
@@ -155,9 +155,9 @@ public byte[] hmac(final byte[] key, final byte[] valueToDigest) {
155155
* Returns a keyed-Hash Message Authentication Code (HMAC) for the given key and value.
156156
*
157157
* @param key
158-
* They key for the keyed digest (must not be null)
158+
* The key for the keyed digest (must not be null)
159159
* @param valueToDigest
160-
* The value (data) which should to digest. The InputStream must not be null and will not be closed.
160+
* The value (data) to digest. The InputStream must not be null and will not be closed.
161161
* @return HMAC for the given key and value
162162
* @throws IOException
163163
* If an I/O error occurs.
@@ -171,11 +171,12 @@ public byte[] hmac(final byte[] key, final InputStream valueToDigest) throws IOE
171171

172172
/**
173173
* Returns a keyed-Hash Message Authentication Code (HMAC) for the given key and value.
174+
* The Strings are converted to bytes using the UTF-8 charset.
174175
*
175176
* @param key
176-
* They key for the keyed digest (must not be null)
177+
* The key for the keyed digest (must not be null)
177178
* @param valueToDigest
178-
* The value (data) which should to digest (maybe empty or null)
179+
* The value (data) to digest (maybe empty or null)
179180
* @return HMAC for the given key and value
180181
* @throws IllegalArgumentException
181182
* when a {@link NoSuchAlgorithmException} is caught or key is null or key is invalid.
@@ -189,9 +190,9 @@ public byte[] hmac(final String key, final String valueToDigest) {
189190
* Returns a keyed-Hash Message Authentication Code (HMAC) as a hex string (lowercase) for the given key and value.
190191
*
191192
* @param key
192-
* They key for the keyed digest (must not be null)
193+
* The key for the keyed digest (must not be null)
193194
* @param valueToDigest
194-
* The value (data) which should to digest (maybe empty or null)
195+
* The value (data) to digest (maybe empty or null)
195196
* @return HMAC for the given key and value as a hex string (lowercase)
196197
* @throws IllegalArgumentException
197198
* when a {@link NoSuchAlgorithmException} is caught or key is null or key is invalid.
@@ -205,9 +206,9 @@ public String hmacHex(final byte[] key, final byte[] valueToDigest) {
205206
* Returns a keyed-Hash Message Authentication Code (HMAC) as a hex string (lowercase) for the given key and value.
206207
*
207208
* @param key
208-
* They key for the keyed digest (must not be null)
209+
* The key for the keyed digest (must not be null)
209210
* @param valueToDigest
210-
* The value (data) which should to digest. The InputStream must not be null and will not be closed.
211+
* The value (data) to digest. The InputStream must not be null and will not be closed.
211212
* @return HMAC for the given key and value as a hex string (lowercase)
212213
* @throws IOException
213214
* If an I/O error occurs.
@@ -223,9 +224,9 @@ public String hmacHex(final byte[] key, final InputStream valueToDigest) throws
223224
* Returns a keyed-Hash Message Authentication Code (HMAC) as a hex string (lowercase) for the given key and value.
224225
*
225226
* @param key
226-
* They key for the keyed digest (must not be null)
227+
* The key for the keyed digest (must not be null)
227228
* @param valueToDigest
228-
* The value (data) which should to digest (maybe empty or null)
229+
* The value (data) to digest (maybe empty or null)
229230
* @return HMAC for the given key and value as a hex string (lowercase)
230231
* @throws IllegalArgumentException
231232
* when a {@link NoSuchAlgorithmException} is caught or key is null or key is invalid.

0 commit comments

Comments
 (0)