com.auth0.android.jwt

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 Type	Method and Description
<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.
<T> T	asObject(java.lang.Class<T> tClazz) Get this Claim as a Object of type T.
java.lang.String	asString() Get this Claim as a String.

Method Detail

asBoolean

@Nullable
java.lang.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

@Nullable
java.lang.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

@Nullable
java.lang.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

@Nullable
java.lang.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

@Nullable
java.lang.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

@Nullable
java.util.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(java.lang.Class<T> tClazz)
         throws DecodeException

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

Returns:

the value as an Array or an empty Array.

Throws:

DecodeException - if the values inside the Array can't be converted to a class T.

asList

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

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

Returns:

the value as a List or an empty List.

Throws:

DecodeException - if the values inside the List can't be converted to a class T.

asObject

@Nullable
<T> T asObject(java.lang.Class<T> tClazz)
                  throws DecodeException

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

Returns:

the value as a Object of type T or null.

Throws:

DecodeException - if the value can't be converted to a class T.