Skip to content

class HttpHeadersBase

cangjie
public abstract class HttpHeadersBase <: Iterable<(String, Collection<String>)>

功能:表示 HTTP 头集合的抽象基类。

父类型:

  • Iterable<(String, Collection<String>)>

成员概览

成员功能
init(HttpHeaders)使用底层头集合创建头基类实例。
func iterator()获取头集合迭代器。
func add(String, String)添加一个头值。
func tryAddWithoutValidation(String, String)尝试绕过头类型校验直接写入头值。
func contains(String)检查是否包含指定头。
func set(String, String)设置指定头值。
func remove(String)删除指定头。
func get(String)获取指定头的全部值。
func getFirst(String)获取指定头的第一个值。

init(HttpHeaders)

cangjie
protected init(headers: HttpHeaders)

功能:使用底层头集合创建头基类实例。

参数:

  • headers: HttpHeaders - 底层 HTTP 头集合。

func iterator()

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

功能:获取头集合迭代器。

返回值:

  • Iterator<(String, Collection<String>)> - 当前头集合的迭代器。

func add(String, String)

cangjie
public open func add(name: String, value: String): Unit

功能:添加一个头值。

参数:

  • name: String - 头名称。
  • value: String - 头值。

返回值:

  • Unit - 无返回值。

func tryAddWithoutValidation(String, String)

cangjie
public open func tryAddWithoutValidation(name: String, value: String): Bool

功能:尝试绕过头类型校验直接写入头值。

参数:

  • name: String - 头名称。
  • value: String - 头值。

返回值:

  • Bool - 当前实现始终返回 true

func contains(String)

cangjie
public func contains(name: String): Bool

功能:检查是否包含指定头。

参数:

  • name: String - 头名称。

返回值:

  • Bool - 存在该头时返回 true

func set(String, String)

cangjie
public open func set(name: String, value: String): Unit

功能:设置指定头值。

参数:

  • name: String - 头名称。
  • value: String - 头值。

返回值:

  • Unit - 无返回值。

func remove(String)

cangjie
public func remove(name: String): Unit

功能:删除指定头。

参数:

  • name: String - 头名称。

返回值:

  • Unit - 无返回值。

func get(String)

cangjie
public func get(name: String): ?Collection<String>

功能:获取指定头的全部值。

参数:

  • name: String - 头名称。

返回值:

  • ?Collection<String> - 指定头的值集合;不存在时返回 None

func getFirst(String)

cangjie
public func getFirst(name: String): ?String

功能:获取指定头的第一个值。

参数:

  • name: String - 头名称。

返回值:

  • ?String - 指定头的第一个值;不存在时返回 None