Interface Claim

lib/src/main/java/com/auth0/jwt/interfaces/Claim.java:13–131

The Claim class holds the value in a generic way so that it can be recovered in many representations.

 * The Claim class holds the value in a generic way so that it can be recovered in many representations.
 */
public interface Claim {

    /**
     * Whether this Claim has a null value or not.
     * If the claim is not present, it will return false hence checking {@link Claim#isMissing} is advised as well
     *
     * @return whether this Claim has a null value or not.
     */
    boolean isNull();

    /**
     * Can be used to verify whether the Claim is found or not.
     * This will be true even if the Claim has {@code null} value associated to it.
     *
     * @return whether this Claim is present or not
     */
    boolean isMissing();

    /**
     * Get this Claim as a Boolean.
     * If the value isn't of type Boolean or it can't be converted to a Boolean, {@code null} will be returned.
     *
     * @return the value as a Boolean or null.
     */
    Boolean asBoolean();

    /**
     * Get this Claim as an Integer.
     * If the value isn't of type Integer or it can't be converted to an Integer, {@code null} will be returned.
     *
     * @return the value as an Integer or null.
     */
    Integer asInt();

    /**
     * Get this Claim as an Long.
     * If the value isn't of type Long or it can't be converted to a Long, {@code null} will be returned.
     *
     * @return the value as an Long or null.
     */
    Long asLong();

    /**
     * Get this Claim as a Double.
     * If the value isn't of type Double or it can't be converted to a Double, {@code null} will be returned.
     *
     * @return the value as a Double or null.
     */
    Double asDouble();

    /**
     * Get this Claim as a String.
     * If the value isn't of type String, {@code null} will be returned. For a String representation of non-textual
     * claim types, clients can call {@code toString()}.
     *
     * @return the value as a String or null if the underlying value is not a string.
     */
    String asString();