Interface Claim

  • All Known Implementing Classes:
    NullClaim

    public interface Claim
    The Claim class holds the value in a generic way so that it can be recovered in many representations.
    • Method Detail

      • isNull

        boolean isNull()
        Whether this Claim has a null value or not.
        Returns:
        whether this Claim has a null value or not.
      • asBoolean

        Boolean asBoolean()
        Get this Claim as a Boolean. If the value isn't of type Boolean or it can't be converted to a Boolean, null will be returned.
        Returns:
        the value as a Boolean or null.
      • asInt

        Integer asInt()
        Get this Claim as an Integer. If the value isn't of type Integer or it can't be converted to an Integer, null will be returned.
        Returns:
        the value as an Integer or null.
      • asLong

        Long asLong()
        Get this Claim as an Long. If the value isn't of type Long or it can't be converted to an Long, null will be returned.
        Returns:
        the value as an Long or null.
      • asDouble

        Double asDouble()
        Get this Claim as a Double. If the value isn't of type Double or it can't be converted to a Double, null will be returned.
        Returns:
        the value as a Double or null.
      • asString

        String asString()
        Get this Claim as a String. If the value isn't of type String or it can't be converted to a String, null will be returned.
        Returns:
        the value as a String or null.
      • asDate

        Date asDate()
        Get this Claim as a Date. If the value can't be converted to a Date, null will be returned.
        Returns:
        the value as a Date or null.
      • asArray

        <T> T[] asArray​(Class<T> tClazz)
                 throws JWTDecodeException
        Get this Claim as an Array of type T. If the value isn't an Array, null will be returned.
        Type Parameters:
        T - type
        Parameters:
        tClazz - the type class
        Returns:
        the value as an Array or null.
        Throws:
        JWTDecodeException - if the values inside the Array can't be converted to a class T.
      • asList

        <T> List<T> asList​(Class<T> tClazz)
                    throws JWTDecodeException
        Get this Claim as a List of type T. If the value isn't an Array, null will be returned.
        Type Parameters:
        T - type
        Parameters:
        tClazz - the type class
        Returns:
        the value as a List or null.
        Throws:
        JWTDecodeException - if the values inside the List can't be converted to a class T.
      • as

        <T> T as​(Class<T> tClazz)
          throws JWTDecodeException
        Get this Claim as a custom type T.
        Type Parameters:
        T - type
        Parameters:
        tClazz - the type class
        Returns:
        the value as instance of T.
        Throws:
        JWTDecodeException - if the value can't be converted to a class T.