cn.hutool.http

Enum GlobalHeaders

java.lang.Object

java.lang.Enum<GlobalHeaders>

cn.hutool.http.GlobalHeaders

All Implemented Interfaces:

Serializable, Comparable<GlobalHeaders>

public enum GlobalHeaders
extends Enum<GlobalHeaders>

全局头部信息
所有Http请求将共用此全局头部信息，除非在HttpRequest中自定义头部信息覆盖之

Author:

looly

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
GlobalHeaders	clearHeaders() 清除所有头信息，包括全局头信息
String	header(Header name) 根据name获取头信息
GlobalHeaders	header(Header name, String value) 设置一个header 覆盖模式，则替换之前的值
GlobalHeaders	header(Header 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(Header name) 移除一个头信息
GlobalHeaders	removeHeader(String name) 移除一个头信息
static GlobalHeaders	valueOf(String name) Returns the enum constant of this type with the specified name.
static GlobalHeaders[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final GlobalHeaders INSTANCE

Method Detail

values

public static GlobalHeaders[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

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

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GlobalHeaders valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

putDefault

public GlobalHeaders putDefault(boolean isReset)

加入默认的头部信息

Parameters:

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

Returns:

this

header

public String header(String name)

根据name获取头信息

Parameters:

name - Header名

Returns:

Header值

headerList

public List<String> headerList(String name)

根据name获取头信息列表

Parameters:

name - Header名

Returns:

Header值

Since:

3.1.1

header

public String header(Header name)

根据name获取头信息

Parameters:

name - Header名

Returns:

Header值

header

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

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

Parameters:

name - Header名

value - Header值

isOverride - 是否覆盖已有值

Returns:

this

header

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

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

Parameters:

name - Header名

value - Header值

isOverride - 是否覆盖已有值

Returns:

this

header

public GlobalHeaders header(Header name,
                            String value)

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

Parameters:

name - Header名

value - Header值

Returns:

this

header

public GlobalHeaders header(String name,
                            String value)

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

Parameters:

name - Header名

value - Header值

Returns:

this

header

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

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

Parameters:

headers - 请求头

Returns:

this

removeHeader

public GlobalHeaders removeHeader(String name)

移除一个头信息

Parameters:

name - Header名

Returns:

this

removeHeader

public GlobalHeaders removeHeader(Header name)

移除一个头信息

Parameters:

name - Header名

Returns:

this

headers

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

获取headers

Returns:

Headers Map

clearHeaders

public GlobalHeaders clearHeaders()

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

Returns:

this

Since:

5.7.13