From 7c6c7df926dbacc136f002d51146b95e85f3b864 Mon Sep 17 00:00:00 2001 From: Micah Silverman Date: Fri, 1 Sep 2017 03:18:28 -0700 Subject: [PATCH] Minor punctuation and sentence structure updates. Changed Json to JSON per spec. --- src/main/java/io/jsonwebtoken/Header.java | 23 ++++++++++--------- src/main/java/io/jsonwebtoken/JwtBuilder.java | 4 ++-- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/src/main/java/io/jsonwebtoken/Header.java b/src/main/java/io/jsonwebtoken/Header.java index ba6b850c..1d8ab9af 100644 --- a/src/main/java/io/jsonwebtoken/Header.java +++ b/src/main/java/io/jsonwebtoken/Header.java @@ -115,11 +115,11 @@ public interface Header> extends Map { * *
Compatiblity Note
* - *

While the JWT family of specifications only defines the zip header in the JWE (Json Web Encryption) - * specification, JJWT will also support compression for JWS as well if you choose to use it. However, - * be aware that if you use - * compression when creating a JWS token, other libraries may not be able to parse the JWS. Compression when - * creating JWE tokens however should be universally accepted for any library that supports JWE.

+ *

While the JWT family of specifications only defines the zip header in the JWE + * (JSON Web Encryption) specification, JJWT will also support compression for JWS as well if you choose to use it. + * However, be aware that if you use compression when creating a JWS token, other libraries may not be able to + * parse the JWS. However, compression when creating JWE tokens should be universally accepted for any library + * that supports JWE.

* * @return the {@code zip} header parameter value or {@code null} if not present. * @since 0.6.0 @@ -133,13 +133,14 @@ public interface Header> extends Map { * *
Compatiblity Note
* - *

While the JWT family of specifications only defines the zip header in the JWE (Json Web Encryption) - * specification, JJWT will also support compression for JWS as well if you choose to use it. However, - * be aware that if you use - * compression when creating a JWS token, other libraries may not be able to parse the JWS. Compression when - * creating JWE tokens however should be universally accepted for any library that supports JWE.

+ *

While the JWT family of specifications only defines the zip header in the JWE + * (JSON Web Encryption) specification, JJWT will also support compression for JWS as well if you choose to use it. + * However, be aware that if you use compression when creating a JWS token, other libraries may not be able to + * parse the JWS. However, Compression when creating JWE tokens should be universally accepted for any library + * that supports JWE.

* - * @param zip the JWT compression algorithm {@code zip} value or {@code null} to remove the property from the JSON map. + * @param zip the JWT compression algorithm {@code zip} value or {@code null} to remove the property from the + * JSON map. * @since 0.6.0 */ T setCompressionAlgorithm(String zip); diff --git a/src/main/java/io/jsonwebtoken/JwtBuilder.java b/src/main/java/io/jsonwebtoken/JwtBuilder.java index 4cb012f2..782352f0 100644 --- a/src/main/java/io/jsonwebtoken/JwtBuilder.java +++ b/src/main/java/io/jsonwebtoken/JwtBuilder.java @@ -370,10 +370,10 @@ public interface JwtBuilder extends ClaimsMutator { * *
Compatibility Warning
* - *

The JWT family of specifications defines compression only for JWE (Json Web Encryption) + *

The JWT family of specifications defines compression only for JWE (JSON Web Encryption) * tokens. Even so, JJWT will also support compression for JWS tokens as well if you choose to use it. * However, be aware that if you use compression when creating a JWS token, other libraries may not be able to - * parse that JWS token. When using compression for JWS tokens, be sure that that all parties accessing the + * parse that JWS token. When using compression for JWS tokens, be sure that that all parties accessing the * JWS token support compression for JWS.

* *

Compression when creating JWE tokens however should be universally accepted for any