com.auth0.jwt.impl

Class NullClaim

java.lang.Object

com.auth0.jwt.impl.NullClaim

All Implemented Interfaces:

Claim

public class NullClaim
extends java.lang.Object
implements Claim

The NullClaim class is a Claim implementation that returns null when any of it's methods it's called.

Constructor Summary

Constructors

Constructor and Description
NullClaim()

Method Summary

Modifier and Type	Method and Description
<T> T	as(java.lang.Class<T> tClazz) Get this Claim as a custom type T.
<T> T[]	asArray(java.lang.Class<T> tClazz) Get this Claim as an Array of type T.
java.lang.Boolean	asBoolean() Get this Claim as a Boolean.
java.util.Date	asDate() Get this Claim as a Date.
java.lang.Double	asDouble() Get this Claim as a Double.
java.lang.Integer	asInt() Get this Claim as an Integer.
<T> java.util.List<T>	asList(java.lang.Class<T> tClazz) Get this Claim as a List of type T.
java.lang.Long	asLong() Get this Claim as an Long.
java.util.Map<java.lang.String,java.lang.Object>	asMap() Get this Claim as a generic Map of values.
java.lang.String	asString() Get this Claim as a String.
boolean	isNull() Whether this Claim has a null value or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NullClaim

public NullClaim()

Method Detail

isNull

public boolean isNull()

Description copied from interface: Claim

Whether this Claim has a null value or not.

Specified by:

isNull in interface Claim

Returns:

whether this Claim has a null value or not.

asBoolean

public java.lang.Boolean asBoolean()

Description copied from interface: Claim

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.

Specified by:

asBoolean in interface Claim

Returns:

the value as a Boolean or null.

asInt

public java.lang.Integer asInt()

Description copied from interface: Claim

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.

Specified by:

asInt in interface Claim

Returns:

the value as an Integer or null.

asLong

public java.lang.Long asLong()

Description copied from interface: Claim

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.

Specified by:

asLong in interface Claim

Returns:

the value as an Long or null.

asDouble

public java.lang.Double asDouble()

Description copied from interface: Claim

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.

Specified by:

asDouble in interface Claim

Returns:

the value as a Double or null.

asString

public java.lang.String asString()

Description copied from interface: Claim

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.

Specified by:

asString in interface Claim

Returns:

the value as a String or null.

asDate

public java.util.Date asDate()

Description copied from interface: Claim

Get this Claim as a Date. If the value can't be converted to a Date, null will be returned.

Specified by:

asDate in interface Claim

Returns:

the value as a Date or null.

asArray

public <T> T[] asArray(java.lang.Class<T> tClazz)
                throws JWTDecodeException

Description copied from interface: Claim

Get this Claim as an Array of type T. If the value isn't an Array, null will be returned.

Specified by:

asArray in interface Claim

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

public <T> java.util.List<T> asList(java.lang.Class<T> tClazz)
                             throws JWTDecodeException

Description copied from interface: Claim

Get this Claim as a List of type T. If the value isn't an Array, null will be returned.

Specified by:

asList in interface Claim

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.

asMap

public java.util.Map<java.lang.String,java.lang.Object> asMap()
                                                       throws JWTDecodeException

Description copied from interface: Claim

Get this Claim as a generic Map of values.

Specified by:

asMap in interface Claim

Returns:

the value as instance of Map.

Throws:

JWTDecodeException - if the value can't be converted to a Map.

as

public <T> T as(java.lang.Class<T> tClazz)
         throws JWTDecodeException

Description copied from interface: Claim

Get this Claim as a custom type T.

Specified by:

as in interface Claim

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.