Spire 天擎

外观

class JwtContent ​

cangjie
public abstract class JwtContent <: Map<String, Any>

功能：表示 JWT 头部或载荷的键值内容基类。

父类型：

  • Map<String, Any>

成员概览 ​

成员功能
prop size获取内容项数量。
func [](String)按名称读取内容项。
func [](String, Any)按名称写入内容项。
func add(String, Any)添加单个内容项。
func add(Collection<(String, Any)>)批量添加内容项。
func clear()清空全部内容项。
func contains(String)检查是否包含指定键名。
func contains(Collection<String>)检查是否同时包含指定键名集合。
func entryView(String)获取指定键的条目视图。
func get(String)按名称获取内容值。
func isEmpty()检查当前内容是否为空。
func iterator()获取内容项迭代器。
func remove(String)删除指定键名的内容项。
func remove(Collection<String>)批量删除指定键名集合。
func removeIf((String, Any) -> Bool)删除满足条件的内容项。
func keys()获取全部键名集合。
func values()获取全部内容值集合。
func serializeToJson()将当前内容序列化为 JSON 字符串。
func base64UrlEncode()将当前内容编码为 Base64Url 字符串。
func toClaims()将当前内容转换为声明集合。

prop size ​

cangjie
public prop size: Int64

功能：获取内容项数量。

类型：Int64

func [](String) ​

cangjie
public operator func [](name: String): Any

功能：按名称读取内容项。

参数：

  • name: String - 要读取的键名。

返回值：

  • Any - 对应的内容值。

异常：

  • NoneValueException - 当指定键名不存在时抛出。

func [](String, Any) ​

cangjie
public operator func [](name: String, value!: Any): Unit

功能：按名称写入内容项。

参数：

  • name: String - 要写入的键名。
  • value: Any - 要写入的值。

返回值：

  • Unit - 无返回值。

func add(String, Any) ​

cangjie
public func add(name: String, value: Any): ?Any

功能：添加单个内容项。

参数：

  • name: String - 要添加的键名。
  • value: Any - 要添加的值。

返回值：

  • ?Any - 被替换或聚合前的旧值；首次添加时返回 None。

func add(Collection<(String, Any)>) ​

cangjie
public func add(all!: Collection<(String, Any)>): Unit

功能：批量添加内容项。

参数：

  • all: Collection<(String, Any)> - 要添加的键值集合。

返回值：

  • Unit - 无返回值。

func clear() ​

cangjie
public func clear(): Unit

功能：清空全部内容项。

返回值：

  • Unit - 无返回值。

func contains(String) ​

cangjie
public func contains(name: String): Bool

功能：检查是否包含指定键名。

参数：

  • name: String - 要检查的键名。

返回值：

  • Bool - 包含该键名时返回 true。

func contains(Collection<String>) ​

cangjie
public func contains(all!: Collection<String>): Bool

功能：检查是否同时包含指定键名集合。

参数：

  • all: Collection<String> - 要检查的键名集合。

返回值：

  • Bool - 全部键名都存在时返回 true。

func entryView(String) ​

cangjie
public func entryView(name: String): MapEntryView<String, Any>

功能：获取指定键的条目视图。

参数：

  • name: String - 要查看的键名。

返回值：

  • MapEntryView<String, Any> - 对应键的条目视图。

func get(String) ​

cangjie
public func get(name: String): ?Any

功能：按名称获取内容值。

参数：

  • name: String - 要获取的键名。

返回值：

  • ?Any - 对应的内容值；不存在时返回 None。

func isEmpty() ​

cangjie
public func isEmpty(): Bool

功能：检查当前内容是否为空。

返回值：

  • Bool - 没有任何内容项时返回 true。

func iterator() ​

cangjie
public func iterator(): Iterator<(String, Any)>

功能：获取内容项迭代器。

返回值：

  • Iterator<(String, Any)> - 当前内容项的迭代器。

func remove(String) ​

cangjie
public func remove(name: String): ?Any

功能：删除指定键名的内容项。

参数：

  • name: String - 要删除的键名。

返回值：

  • ?Any - 被删除的值；不存在时返回 None。

func remove(Collection<String>) ​

cangjie
public func remove(all!: Collection<String>): Unit

功能：批量删除指定键名集合。

参数：

  • all: Collection<String> - 要删除的键名集合。

返回值：

  • Unit - 无返回值。

func removeIf((String, Any) -> Bool) ​

cangjie
public func removeIf(predicate: (String, Any) -> Bool): Unit

功能：删除满足条件的内容项。

参数：

  • predicate: (String, Any) -> Bool - 用于判断是否删除的条件函数。

返回值：

  • Unit - 无返回值。

func keys() ​

cangjie
public func keys(): EquatableCollection<String>

功能：获取全部键名集合。

返回值：

  • EquatableCollection<String> - 当前内容的键名集合视图。

func values() ​

cangjie
public func values(): Collection<Any>

功能：获取全部内容值集合。

返回值：

  • Collection<Any> - 当前内容的值集合视图。

func serializeToJson() ​

cangjie
public func serializeToJson(): String

功能：将当前内容序列化为 JSON 字符串。

返回值：

  • String - 序列化后的 JSON 字符串。

func base64UrlEncode() ​

cangjie
public func base64UrlEncode(): String

功能：将当前内容编码为 Base64Url 字符串。

返回值：

  • String - Base64Url 编码后的内容字符串。

func toClaims() ​

cangjie
public func toClaims(): ArrayList<Claim>

功能：将当前内容转换为声明集合。

返回值：

  • ArrayList<Claim> - 转换得到的声明列表。