Package com.auth0.jwt.interfaces
Interface Claim
public interface Claim
The Claim class holds the value in a generic way so that it can be recovered in many representations.
-
Method Summary
Modifier and TypeMethodDescription<T> T
Get this Claim as a custom type T.<T> T[]
Get this Claim as an Array of type T.Get this Claim as a Boolean.asDate()
Get this Claim as a Date.asDouble()
Get this Claim as a Double.default Instant
Get this Claim as an Instant.asInt()
Get this Claim as an Integer.<T> List<T>
Get this Claim as a List of type T.asLong()
Get this Claim as an Long.asMap()
Get this Claim as a generic Map of values.asString()
Get this Claim as a String.boolean
Can be used to verify whether the Claim is found or not.boolean
isNull()
Whether this Claim has a null value or not.
-
Method Details
-
isNull
boolean isNull()Whether this Claim has a null value or not. If the claim is not present, it will return false hence checkingisMissing()
is advised as well- Returns:
- whether this Claim has a null value or not.
-
isMissing
boolean isMissing()Can be used to verify whether the Claim is found or not. This will be true even if the Claim hasnull
value associated to it.- Returns:
- whether this Claim is present 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 a 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,null
will be returned. For a String representation of non-textual claim types, clients can calltoString()
.- Returns:
- the value as a String or null if the underlying value is not a string.
-
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.
-
asInstant
Get this Claim as an Instant. If the value can't be converted to an Instant,null
will be returned.- Returns:
- the value as a Date or null.
-
asArray
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:
clazz
- 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
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:
clazz
- 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.
-
asMap
Get this Claim as a generic Map of values.- Returns:
- the value as instance of Map.
- Throws:
JWTDecodeException
- if the value can't be converted to a Map.
-
as
Get this Claim as a custom type T. This method will return null ifisMissing()
orisNull()
is true- Type Parameters:
T
- type- Parameters:
clazz
- the type class- Returns:
- the value as instance of T.
- Throws:
JWTDecodeException
- if the value can't be converted to a class T.
-