Skip to content

Commit c27754f

Browse files
committed
Improve Javadoc description of deprecation.
Per feedback from @juneb
1 parent 656ae1e commit c27754f

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -282,8 +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 not out-of-the-box
286-
* compatible with the other Encryption SDKs and intentionally not supported by the other implementations.
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.
287288
*/
288289
@Deprecated
289290
public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(
@@ -300,8 +301,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(
300301
* Calls {@link #encryptData(CryptoMaterialsManager, byte[], Map)} on the UTF-8 encoded bytes of
301302
* {@code plaintext} and base64 encodes the result.
302303
* @deprecated Use the {@link #encryptData(CryptoMaterialsManager, byte[], Map)} and
303-
* {@link #decryptData(CryptoMaterialsManager, byte[])} APIs instead. {@code encryptString} is not out-of-the-box
304-
* compatible with the other Encryption SDKs and intentionally not supported by the other implementations.
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.
305307
*/
306308
@Deprecated
307309
public CryptoResult<String, ?> encryptString(
@@ -322,8 +324,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(
322324
* Returns the equivalent to calling {@link #encryptString(MasterKeyProvider, String, Map)} with
323325
* an empty {@code encryptionContext}.
324326
* @deprecated Use the {@link #encryptData(MasterKeyProvider, byte[])} and
325-
* {@link #decryptData(MasterKeyProvider, byte[])} APIs instead. {@code encryptString} is not out-of-the-box
326-
* compatible with the other Encryption SDKs and intentionally not supported the by other implementations.
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.
327330
*/
328331
@Deprecated
329332
public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(final MasterKeyProvider<K> provider,
@@ -335,8 +338,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> encryptString(final Mast
335338
* Returns the equivalent to calling {@link #encryptString(CryptoMaterialsManager, String, Map)} with
336339
* an empty {@code encryptionContext}.
337340
* @deprecated Use the {@link #encryptData(CryptoMaterialsManager, byte[])} and
338-
* {@link #decryptData(CryptoMaterialsManager, byte[])} APIs instead. {@code encryptString} is not out-of-the-box
339-
* compatible with the other Encryption SDKs and intentionally not supported the by other implementations.
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.
340344
*/
341345
@Deprecated
342346
public CryptoResult<String, ?> encryptString(
@@ -419,8 +423,9 @@ public <K extends MasterKey<K>> CryptoResult<byte[], K> decryptData(
419423
*
420424
* @see #decryptData(MasterKeyProvider, byte[])
421425
* @deprecated Use the {@link #decryptData(MasterKeyProvider, byte[])} and
422-
* {@link #encryptData(MasterKeyProvider, byte[], Map)} APIs instead. {@code decryptString} is not out-of-the-box
423-
* compatible with the other Encryption SDKs and intentionally not supported the by other implementations.
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.
424429
*/
425430
@Deprecated
426431
@SuppressWarnings("unchecked")
@@ -437,8 +442,9 @@ public <K extends MasterKey<K>> CryptoResult<String, K> decryptString(
437442
*
438443
* @see #decryptData(CryptoMaterialsManager, byte[])
439444
* @deprecated Use the {@link #decryptData(CryptoMaterialsManager, byte[])} and
440-
* {@link #encryptData(CryptoMaterialsManager, byte[], Map)} APIs instead. {@code decryptString} is not out-of-the-box
441-
* compatible with the other Encryption SDKs and intentionally not supported the by other implementations.
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.
442448
*/
443449
@Deprecated
444450
public CryptoResult<String, ?> decryptString(final CryptoMaterialsManager provider,

0 commit comments

Comments
 (0)