Skip to content

Commit 7704385

Browse files
committed
Fix incorrect description.
Whoops.
1 parent b60f8f1 commit 7704385

File tree

1 file changed

+18
-24
lines changed

1 file changed

+18
-24
lines changed

src/main/java/com/amazonaws/encryptionsdk/AwsCrypto.java

+18-24
Original file line numberDiff line numberDiff line change
@@ -283,10 +283,9 @@ public <K extends MasterKey<K>> CryptoResult<byte[], K> encryptData(final Master
283283
* {@code plaintext} and base64 encodes the result.
284284
* @deprecated Use the {@link #encryptData(MasterKeyProvider, byte[], Map)} and
285285
* {@link #decryptData(MasterKeyProvider, byte[])} APIs instead. {@code encryptString} and {@code decryptString}
286-
* work as expected if you use them together. However, to work with other language implementations of the AWS
287-
* Encryption SDK, you need to base64 decode the output of {@code encryptString}.
288-
* {@code decryptString} will base64 decode plaintext before returning the result.
289-
* These deprecated APIs will be removed in the future.
286+
* work as expected if you use them together. However, to work with other language implementations of the AWS
287+
* Encryption SDK, you need to base64-decode the output of {@code encryptString} and base64-encode the input to
288+
* {@code decryptString}. These deprecated APIs will be removed in the future.
290289
*/
291290
@Deprecated
292291
public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(
@@ -304,10 +303,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(
304303
* {@code plaintext} and base64 encodes the result.
305304
* @deprecated Use the {@link #encryptData(CryptoMaterialsManager, byte[], Map)} and
306305
* {@link #decryptData(CryptoMaterialsManager, byte[])} APIs instead. {@code encryptString} and {@code decryptString}
307-
* work as expected if you use them together. However, to work with other language implementations of the AWS
308-
* Encryption SDK, you need to base64 decode the output of {@code encryptString}.
309-
* {@code decryptString} will base64 decode plaintext before returning the result.
310-
* These deprecated APIs will be removed in the future.
306+
* work as expected if you use them together. However, to work with other language implementations of the AWS
307+
* Encryption SDK, you need to base64-decode the output of {@code encryptString} and base64-encode the input to
308+
* {@code decryptString}. These deprecated APIs will be removed in the future.
311309
*/
312310
@Deprecated
313311
public CryptoResult<String, ?> encryptString(
@@ -329,10 +327,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(
329327
* an empty {@code encryptionContext}.
330328
* @deprecated Use the {@link #encryptData(MasterKeyProvider, byte[])} and
331329
* {@link #decryptData(MasterKeyProvider, byte[])} APIs instead. {@code encryptString} and {@code decryptString}
332-
* work as expected if you use them together. However, to work with other language implementations of the AWS
333-
* Encryption SDK, you need to base64 decode the output of {@code encryptString}.
334-
* {@code decryptString} will base64 decode plaintext before returning the result.
335-
* These deprecated APIs will be removed in the future.
330+
* work as expected if you use them together. However, to work with other language implementations of the AWS
331+
* Encryption SDK, you need to base64-decode the output of {@code encryptString} and base64-encode the input to
332+
* {@code decryptString}. These deprecated APIs will be removed in the future.
336333
*/
337334
@Deprecated
338335
public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(final MasterKeyProvider<K> provider,
@@ -345,10 +342,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(final Mast
345342
* an empty {@code encryptionContext}.
346343
* @deprecated Use the {@link #encryptData(CryptoMaterialsManager, byte[])} and
347344
* {@link #decryptData(CryptoMaterialsManager, byte[])} APIs instead. {@code encryptString} and {@code decryptString}
348-
* work as expected if you use them together. However, to work with other language implementations of the AWS
349-
* Encryption SDK, you need to base64 decode the output of {@code encryptString}.
350-
* {@code decryptString} will base64 decode plaintext before returning the result.
351-
* These deprecated APIs will be removed in the future.
345+
* work as expected if you use them together. However, to work with other language implementations of the AWS
346+
* Encryption SDK, you need to base64-decode the output of {@code encryptString} and base64-encode the input to
347+
* {@code decryptString}. These deprecated APIs will be removed in the future.
352348
*/
353349
@Deprecated
354350
public CryptoResult<String, ?> encryptString(
@@ -432,10 +428,9 @@ public <K extends MasterKey<K>> CryptoResult<byte[], K> decryptData(
432428
* @see #decryptData(MasterKeyProvider, byte[])
433429
* @deprecated Use the {@link #decryptData(MasterKeyProvider, byte[])} and
434430
* {@link #encryptData(MasterKeyProvider, byte[], Map)} APIs instead. {@code encryptString} and {@code decryptString}
435-
* work as expected if you use them together. However, to work with other language implementations of the AWS
436-
* Encryption SDK, you need to base64 decode the output of {@code encryptString}.
437-
* {@code decryptString} will base64 decode plaintext before returning the result.
438-
* These deprecated APIs will be removed in the future.
431+
* work as expected if you use them together. However, to work with other language implementations of the AWS
432+
* Encryption SDK, you need to base64 decode the output of {@code encryptString} and base64-encode the input to
433+
* {@code decryptString}. These deprecated APIs will be removed in the future.
439434
*/
440435
@Deprecated
441436
@SuppressWarnings("unchecked")
@@ -453,10 +448,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> decryptString(
453448
* @see #decryptData(CryptoMaterialsManager, byte[])
454449
* @deprecated Use the {@link #decryptData(CryptoMaterialsManager, byte[])} and
455450
* {@link #encryptData(CryptoMaterialsManager, byte[], Map)} APIs instead. {@code encryptString} and {@code decryptString}
456-
* work as expected if you use them together. However, to work with other language implementations of the AWS
457-
* Encryption SDK, you need to base64 decode the output of {@code encryptString}.
458-
* {@code decryptString} will base64 decode plaintext before returning the result.
459-
* These deprecated APIs will be removed in the future.
451+
* work as expected if you use them together. However, to work with other language implementations of the AWS
452+
* Encryption SDK, you need to base64-decode the output of {@code encryptString} and base64-encode the input to
453+
* {@code decryptString}. These deprecated APIs will be removed in the future.
460454
*/
461455
@Deprecated
462456
public CryptoResult<String, ?> decryptString(final CryptoMaterialsManager provider,

0 commit comments

Comments
 (0)