org.dromara.hutool.http

枚举 GlobalHeaders

java.lang.Object

java.lang.Enum<GlobalHeaders>

org.dromara.hutool.http.GlobalHeaders

所有已实现的接口:

Serializable, Comparable<GlobalHeaders>

public enum GlobalHeaders
extends Enum<GlobalHeaders>

全局头部信息
所有Http请求将共用此全局头部信息

作者:

looly

枚举常量概要

枚举常量

枚举常量和说明
INSTANCE 单例对象

方法概要

限定符和类型	方法和说明
GlobalHeaders	clearHeaders() 清除所有头信息，包括全局头信息
String	header(HeaderName name) 根据name获取头信息
GlobalHeaders	header(HeaderName name, String value) 设置一个header 覆盖模式，则替换之前的值
GlobalHeaders	header(HeaderName name, String value, boolean isOverride) 设置一个header 如果覆盖模式，则替换之前的值，否则加入到值列表中
GlobalHeaders	header(Map<String,List<String>> headers) 设置请求头 不覆盖原有请求头
String	header(String name) 根据name获取头信息
GlobalHeaders	header(String name, String value) 设置一个header 覆盖模式，则替换之前的值
GlobalHeaders	header(String name, String value, boolean isOverride) 设置一个header 如果覆盖模式，则替换之前的值，否则加入到值列表中
List<String>	headerList(String name) 根据name获取头信息列表
Map<String,List<String>>	headers() 获取headers
GlobalHeaders	putDefault(boolean isReset) 加入默认的头部信息
GlobalHeaders	removeHeader(HeaderName name) 移除一个头信息
GlobalHeaders	removeHeader(String name) 移除一个头信息
static GlobalHeaders	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static GlobalHeaders[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

从类继承的方法 java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

INSTANCE

public static final GlobalHeaders INSTANCE

单例对象

方法详细资料

values

public static GlobalHeaders[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (GlobalHeaders c : GlobalHeaders.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static GlobalHeaders valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

NullPointerException - 如果参数为空值

putDefault

public GlobalHeaders putDefault(boolean isReset)

加入默认的头部信息

参数:

isReset - 是否重置所有头部信息（删除自定义保留默认）

返回:

this

header

public String header(String name)

根据name获取头信息

参数:

name - Header名

返回:

Header值

headerList

public List<String> headerList(String name)

根据name获取头信息列表

参数:

name - Header名

返回:

Header值

从以下版本开始:

3.1.1

header

public String header(HeaderName name)

根据name获取头信息

参数:

name - Header名

返回:

Header值

header

public GlobalHeaders header(String name,
                            String value,
                            boolean isOverride)

设置一个header
如果覆盖模式，则替换之前的值，否则加入到值列表中

参数:

name - Header名

value - Header值

isOverride - 是否覆盖已有值

返回:

this

header

public GlobalHeaders header(HeaderName name,
                            String value,
                            boolean isOverride)

设置一个header
如果覆盖模式，则替换之前的值，否则加入到值列表中

参数:

name - Header名

value - Header值

isOverride - 是否覆盖已有值

返回:

this

header

public GlobalHeaders header(HeaderName name,
                            String value)

设置一个header
覆盖模式，则替换之前的值

参数:

name - Header名

value - Header值

返回:

this

header

public GlobalHeaders header(String name,
                            String value)

设置一个header
覆盖模式，则替换之前的值

参数:

name - Header名

value - Header值

返回:

this

header

public GlobalHeaders header(Map<String,List<String>> headers)

设置请求头
不覆盖原有请求头

参数:

headers - 请求头

返回:

this

removeHeader

public GlobalHeaders removeHeader(String name)

移除一个头信息

参数:

name - Header名

返回:

this

removeHeader

public GlobalHeaders removeHeader(HeaderName name)

移除一个头信息

参数:

name - Header名

返回:

this

headers

public Map<String,List<String>> headers()

获取headers

返回:

Headers Map

clearHeaders

public GlobalHeaders clearHeaders()

清除所有头信息，包括全局头信息

返回:

this

从以下版本开始:

5.7.13