com.auth0.jwt.interfaces.Claim Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-jwt Show documentation
Show all versions of java-jwt Show documentation
Java implementation of JSON Web Token (JWT)
package com.auth0.jwt.interfaces;
import com.auth0.jwt.exceptions.JWTDecodeException;
import java.util.Date;
import java.util.List;
/**
* The Claim class holds the value in a generic way so that it can be recovered in many representations.
*/
public interface Claim {
boolean isNull();
/**
* 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.
*
* @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, null will be returned.
*
* @return the value as an Integer or null.
*/
Integer asInt();
/**
* 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.
*
* @return the value as a Double or null.
*/
Double asDouble();
/**
* 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.
*
* @return the value as a String or null.
*/
String asString();
/**
* Get this Claim as a Date.
* If the value can't be converted to a Date, null will be returned.
*
* @return the value as a Date or null.
*/
Date asDate();
/**
* Get this Claim as an Array of type T.
* If the value isn't an Array, an empty Array will be returned.
*
* @return the value as an Array or an empty Array.
* @throws JWTDecodeException if the values inside the Array can't be converted to a class T.
*/
T[] asArray(Class tClazz) throws JWTDecodeException;
/**
* Get this Claim as a List of type T.
* If the value isn't an Array, an empty List will be returned.
*
* @return the value as a List or an empty List.
* @throws JWTDecodeException if the values inside the List can't be converted to a class T.
*/
List asList(Class tClazz) throws JWTDecodeException;
}