Updated custom Exception javadocs.

cybort · Sep 23, 2015 · 72acd64 · 72acd64
1 parent 5dd95b6
commit 72acd64
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/src/main/java/io/jsonwebtoken/IncorrectClaimException.java b/src/main/java/io/jsonwebtoken/IncorrectClaimException.java
@@ -16,8 +16,8 @@
 package io.jsonwebtoken;
 
 /**
- *  IncorrectClaimException is a subclass of the {@link InvalidClaimException} that is thrown after it is found that an
- *  expected claim has a value that is not expected.
+ * Exception thrown when discovering that a required claim does not equal the required value, indicating the JWT is
+ * invalid and may not be used.
  *
  * @since 0.6
  */

diff --git a/src/main/java/io/jsonwebtoken/InvalidClaimException.java b/src/main/java/io/jsonwebtoken/InvalidClaimException.java
@@ -16,7 +16,11 @@
 package io.jsonwebtoken;
 
 /**
- * InvalidClaimException is a subclass of the {@link ClaimJwtException} that is thrown after a validation of an JTW claim failed.
+ * Exception indicating a parsed claim is invalid in some way.  Subclasses reflect the specific
+ * reason the claim is invalid.
+ *
+ * @see IncorrectClaimException
+ * @see MissingClaimException
  *
  * @since 0.6
  */

diff --git a/src/main/java/io/jsonwebtoken/MissingClaimException.java b/src/main/java/io/jsonwebtoken/MissingClaimException.java
@@ -16,8 +16,8 @@
 package io.jsonwebtoken;
 
 /**
- *  MissingClaimException is a subclass of the {@link InvalidClaimException} that is thrown after it is found that an
- *  expected claim is missing.
+ * Exception thrown when discovering that a required claim is not present, indicating the JWT is
+ * invalid and may not be used.
  *
  * @since 0.6
  */