Skip to content

Commit 5e4b220

Browse files
committed
Clarify Javadoc for deprecation notice.
1 parent c27754f commit 5e4b220

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

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

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -282,9 +282,9 @@ public <K extends MasterKey<K>> CryptoResult<byte[], K> encryptData(final Master
282282
* Calls {@link #encryptData(MasterKeyProvider, byte[], Map)} on the UTF-8 encoded bytes of
283283
* {@code plaintext} and base64 encodes the result.
284284
* @deprecated Use the {@link #encryptData(MasterKeyProvider, byte[], Map)} and
285-
* {@link #decryptData(MasterKeyProvider, byte[])} APIs instead. {@code encryptString} is incompatible with the
286-
* other AWS Encryption SDK language implementations. By design, this feature is not supported by the other
287-
* language implementations.
285+
* {@link #decryptData(MasterKeyProvider, byte[])} APIs instead. {@code encryptString} and {@code decryptString}
286+
* require an extra Base64 decode/encode step to interoperate with other AWS Encryption SDK implementations. Data
287+
* encoding is an application-specific choice. These deprecated APIs will be removed in the future.
288288
*/
289289
@Deprecated
290290
public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(
@@ -301,9 +301,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(
301301
* Calls {@link #encryptData(CryptoMaterialsManager, byte[], Map)} on the UTF-8 encoded bytes of
302302
* {@code plaintext} and base64 encodes the result.
303303
* @deprecated Use the {@link #encryptData(CryptoMaterialsManager, byte[], Map)} and
304-
* {@link #decryptData(CryptoMaterialsManager, byte[])} APIs instead. {@code encryptString} is incompatible with the
305-
* other AWS Encryption SDK language implementations. By design, this feature is not supported by the other
306-
* language implementations.
304+
* {@link #decryptData(CryptoMaterialsManager, byte[])} APIs instead. {@code encryptString} and {@code decryptString}
305+
* require an extra Base64 decode/encode step to interoperate with other AWS Encryption SDK implementations. Data
306+
* encoding is an application-specific choice. These deprecated APIs will be removed in the future.
307307
*/
308308
@Deprecated
309309
public CryptoResult<String, ?> encryptString(
@@ -324,9 +324,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(
324324
* Returns the equivalent to calling {@link #encryptString(MasterKeyProvider, String, Map)} with
325325
* an empty {@code encryptionContext}.
326326
* @deprecated Use the {@link #encryptData(MasterKeyProvider, byte[])} and
327-
* {@link #decryptData(MasterKeyProvider, byte[])} APIs instead. {@code encryptString} is incompatible with the
328-
* other AWS Encryption SDK language implementations. By design, this feature is not supported by the other
329-
* language implementations.
327+
* {@link #decryptData(MasterKeyProvider, byte[])} APIs instead. {@code encryptString} and {@code decryptString}
328+
* require an extra Base64 decode/encode step to interoperate with other AWS Encryption SDK implementations. Data
329+
* encoding is an application-specific choice. These deprecated APIs will be removed in the future.
330330
*/
331331
@Deprecated
332332
public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(final MasterKeyProvider<K> provider,
@@ -338,9 +338,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(final Mast
338338
* Returns the equivalent to calling {@link #encryptString(CryptoMaterialsManager, String, Map)} with
339339
* an empty {@code encryptionContext}.
340340
* @deprecated Use the {@link #encryptData(CryptoMaterialsManager, byte[])} and
341-
* {@link #decryptData(CryptoMaterialsManager, byte[])} APIs instead. {@code encryptString} is incompatible with the
342-
* other AWS Encryption SDK language implementations. By design, this feature is not supported by the other
343-
* language implementations.
341+
* {@link #decryptData(CryptoMaterialsManager, byte[])} APIs instead. {@code encryptString} and {@code decryptString}
342+
* require an extra Base64 decode/encode step to interoperate with other AWS Encryption SDK implementations. Data
343+
* encoding is an application-specific choice. These deprecated APIs will be removed in the future.
344344
*/
345345
@Deprecated
346346
public CryptoResult<String, ?> encryptString(
@@ -423,9 +423,10 @@ public <K extends MasterKey<K>> CryptoResult<byte[], K> decryptData(
423423
*
424424
* @see #decryptData(MasterKeyProvider, byte[])
425425
* @deprecated Use the {@link #decryptData(MasterKeyProvider, byte[])} and
426-
* {@link #encryptData(MasterKeyProvider, byte[], Map)} APIs instead. {@code decryptString} is incompatible with
427-
* the other AWS Encryption SDK language implementations. By design, this feature is not supported by the other
428-
* language implementations.
426+
* {@link #encryptData(MasterKeyProvider, byte[], Map)} APIs instead. {@code encryptString} and
427+
* {@code decryptString} require an extra Base64 decode/encode step to interoperate with other AWS Encryption SDK
428+
* implementations. Data encoding is an application-specific choice. These deprecated APIs will be removed in the
429+
* future.
429430
*/
430431
@Deprecated
431432
@SuppressWarnings("unchecked")
@@ -442,9 +443,10 @@ public <K extends MasterKey<K>> CryptoResult<String, K> decryptString(
442443
*
443444
* @see #decryptData(CryptoMaterialsManager, byte[])
444445
* @deprecated Use the {@link #decryptData(CryptoMaterialsManager, byte[])} and
445-
* {@link #encryptData(CryptoMaterialsManager, byte[], Map)} APIs instead. {@code decryptString} is incompatible
446-
* with the other AWS Encryption SDK language implementations. By design, this feature is not supported by the other
447-
* language implementations.
446+
* {@link #encryptData(CryptoMaterialsManager, byte[], Map)} APIs instead. {@code encryptString} and
447+
* {@code decryptString} require an extra Base64 decode/encode step to interoperate with other AWS Encryption SDK
448+
* implementations. Data encoding is an application-specific choice. These deprecated APIs will be removed in the
449+
* future.
448450
*/
449451
@Deprecated
450452
public CryptoResult<String, ?> decryptString(final CryptoMaterialsManager provider,

0 commit comments

Comments
 (0)