程序包 com.dtflys.forest.http

类 ForestHeaderMap

java.lang.Object
com.dtflys.forest.http.ForestHeaderMap
所有已实现的接口:
Cloneable, Map<String,String>
public class ForestHeaderMap extends Object implements Map<String,String>, Cloneable
Forest请求头Map

该类负责批量管理在Forest请求中所有的请求头信息

从以下版本开始:
2020-08-11 12:45
作者:
gongjun[jun.gong@thebeastshop.com]

  • 构造器详细资料

    • ForestHeaderMap

      public ForestHeaderMap(List<ForestHeader> headers, HasURL hasURL)

    • ForestHeaderMap

      public ForestHeaderMap(HasURL hasURL)

  • 方法详细资料

    • size

      public int size()
      获取本请求头集合的大小
      指定者:
      size 在接口中 Map<String,String>
      返回:
      本请求头集合的大小

    • isEmpty

      public boolean isEmpty()
      指定者:
      isEmpty 在接口中 Map<String,String>

    • getHasURL

      public HasURL getHasURL()

    • containsKey

      public boolean containsKey(Object key)
      指定者:
      containsKey 在接口中 Map<String,String>

    • containsValue

      public boolean containsValue(Object value)
      指定者:
      containsValue 在接口中 Map<String,String>

    • get

      public String get(Object key)
      指定者:
      get 在接口中 Map<String,String>

    • put

      public String put(String key, String value)
      指定者:
      put 在接口中 Map<String,String>

    • remove

      public String remove(Object key)
      根据请求头的名称删除请求头
      指定者:
      remove 在接口中 Map<String,String>
      参数:
      key - 请求头名称
      返回:
      被删除的请求头的值

    • putAll

      public void putAll(Map<? extends String,? extends String> m)
      指定者:
      putAll 在接口中 Map<String,String>

    • clear

      public void clear()
      指定者:
      clear 在接口中 Map<String,String>

    • keySet

      public Set<String> keySet()
      指定者:
      keySet 在接口中 Map<String,String>

    • values

      public Collection<String> values()
      指定者:
      values 在接口中 Map<String,String>

    • entrySet

      public Set<Map.Entry<String,String>> entrySet()
      指定者:
      entrySet 在接口中 Map<String,String>

    • getValue

      public String getValue(String name)
      根据请求头名称获取请求头的值
      参数:
      name - 请求头名称
      返回:
      请求头的值

    • getValues

      public List<String> getValues(String name)
      根据请求头名称获取请求头的值列表
      参数:
      name - 请求头名称
      返回:
      请求头的值列表

    • getHeader

      public ForestHeader getHeader(String name)
      根据请求头名称获取请求头对象
      参数:
      name - 请求头名称
      返回:
      请求头对象，ForestHeader类实例

    • getSetCookies

      public List<ForestCookie> getSetCookies()
      获取Set-Cookie头中的Cookie列表
      返回:
      ForestCookie对象列表
      从以下版本开始:
      1.5.23

    • getSetCookie

      public ForestCookie getSetCookie(String name)
      根据Set-Cookie头的Cookie名称获取Cookie
      参数:
      name - Cookie名称
      返回:
      ForestCookie对象实例
      从以下版本开始:
      1.5.23

    • getHeaders

      public List<ForestHeader> getHeaders(String name)
      根据请求头名称获取请求头对象列表
      参数:
      name - 请求头名称
      返回:
      请求头对象列表，列表项为ForestHeader类实例

    • names

      public List<String> names()
      获取所有请求头的名称列表
      返回:
      所有请求头的名称列表

    • getValues

      public List<String> getValues()
      获取所有请求头的值
      返回:
      所有请求头的值列表

    • addHeader

      public void addHeader(ForestHeader header)
      添加请求头
      参数:
      header - 请求头对象

    • addHeader

      public void addHeader(String name, String value)
      添加请求头
      参数:
      name - 请求头名称
      value - 请求头的值

    • addHeader

      public void addHeader(String name, Lazy<?> value)

    • addCookie

      public void addCookie(ForestCookie cookie)
      添加Cookie头 (默认严格匹配)
      参数:
      cookie - ForestCookie对象实例
      从以下版本开始:
      1.5.23

    • addCookie

      public void addCookie(ForestCookie cookie, boolean strict)
      添加Cookie头
      参数:
      cookie - ForestCookie对象实例
      strict - 是否严格匹配（只有匹配域名，以及没过期的 Cookie 才能添加）
      从以下版本开始:
      1.5.25

    • addCookies

      public void addCookies(List<ForestCookie> cookies)
      批量添加Cookie头 (默认严格匹配)
      参数:
      cookies - ForestCookie对象列表
      从以下版本开始:
      1.5.23

    • addCookies

      public void addCookies(List<ForestCookie> cookies, boolean strict)
      批量添加Cookie头
      参数:
      cookies - ForestCookie对象列表
      strict - 是否严格匹配（只有匹配域名，以及没过期的 Cookie 才能添加）
      从以下版本开始:
      1.5.25

    • addCookies

      public void addCookies(ForestCookies cookies)
      批量添加Cookie头
      参数:
      cookies - ForestCookies对象实例
      从以下版本开始:
      1.5.23

    • setHeader

      public void setHeader(String name, String value)
      设置请求头 当前设置的请求头名称在本集合中已存在的情况下会覆盖原有同名请求头的值，否则便新增一个请求头
      参数:
      name - 请求头名称
      value - 请求头的值

    • setHeader

      public void setHeader(String name, Lazy<?> lazyValue)

    • setHeader

      public void setHeader(Map map)
      通过 Map 批量设置请求头
      参数:
      map - Map对象

    • headerIterator

      public Iterator<ForestHeader> headerIterator()
      获取本请求头集合的迭代器对象
      返回:
      本请求头集合的迭代器对象

    • clone

      public ForestHeaderMap clone(HasURL hasURL)
      克隆Forest请求头Map
      返回:
      新的Forest请求头Map