org.noear.solon.boot.jlhttp

类 HTTPServer.Headers

java.lang.Object

org.noear.solon.boot.jlhttp.HTTPServer.Headers

所有已实现的接口:

Iterable<HTTPServer.Header>

封闭类:

HTTPServer

public static class HTTPServer.Headers
extends Object
implements Iterable<HTTPServer.Header>

The Headers class encapsulates a collection of HTTP headers.

Header names are treated case-insensitively, although this class retains their original case. Header insertion order is maintained as well.

字段概要

字段

限定符和类型	字段和说明
protected int	count
protected HTTPServer.Header[]	headers

构造器概要

构造器

构造器和说明
Headers()

方法概要

限定符和类型	方法和说明
void	add(String name, String value) Adds a header with the given name and value to the end of this collection of headers.
void	addAll(HTTPServer.Headers headers) Adds all given headers to the end of this collection of headers, in their original order.
boolean	contains(String name) Returns whether there exists a header with the given name.
String	get(String name) Returns the value of the first header with the given name.
Date	getDate(String name) Returns the Date value of the header with the given name.
Map<String,String>	getParams(String name) Returns a header's parameters.
Iterator<HTTPServer.Header>	iterator() Returns an iterator over the headers, in their insertion order.
void	remove(String name) Removes all headers with the given name (if any exist).
HTTPServer.Header	replace(String name, String value) Adds a header with the given name and value, replacing the first existing header with the same name.
int	size() Returns the number of added headers.
void	writeTo(OutputStream out) Writes the headers to the given stream (including trailing CRLF).

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 java.lang.Iterable

forEach, spliterator

字段详细资料

headers

protected HTTPServer.Header[] headers

count

protected int count

构造器详细资料

Headers

public Headers()

方法详细资料

size

public int size()

Returns the number of added headers.

返回:

the number of added headers

get

public String get(String name)

Returns the value of the first header with the given name.

参数:

name - the header name (case insensitive)

返回:

the header value, or null if none exists

getDate

public Date getDate(String name)

Returns the Date value of the header with the given name.

参数:

name - the header name (case insensitive)

返回:

the header value as a Date, or null if none exists or if the value is not in any supported date format

contains

public boolean contains(String name)

Returns whether there exists a header with the given name.

参数:

name - the header name (case insensitive)

返回:

whether there exists a header with the given name

add

public void add(String name,
                String value)

Adds a header with the given name and value to the end of this collection of headers. Leading and trailing whitespace are trimmed.

参数:

name - the header name (case insensitive)

value - the header value

addAll

public void addAll(HTTPServer.Headers headers)

Adds all given headers to the end of this collection of headers, in their original order.

参数:

headers - the headers to add

replace

public HTTPServer.Header replace(String name,
                                 String value)

Adds a header with the given name and value, replacing the first existing header with the same name. If there is no existing header with the same name, it is added as in add(java.lang.String, java.lang.String).

参数:

name - the header name (case insensitive)

value - the header value

返回:

the replaced header, or null if none existed

remove

public void remove(String name)

Removes all headers with the given name (if any exist).

参数:

name - the header name (case insensitive)

writeTo

public void writeTo(OutputStream out)
             throws IOException

Writes the headers to the given stream (including trailing CRLF).

参数:

out - the stream to write the headers to

抛出:

IOException - if an error occurs

getParams

public Map<String,String> getParams(String name)

Returns a header's parameters. Parameter order is maintained, and the first key (in iteration order) is the header's value without the parameters.

参数:

name - the header name (case insensitive)

返回:

the header's parameter names and values

iterator

public Iterator<HTTPServer.Header> iterator()

Returns an iterator over the headers, in their insertion order. If the headers collection is modified during iteration, the iteration result is undefined. The remove operation is unsupported.

指定者:

iterator 在接口中 Iterable<HTTPServer.Header>

返回:

an Iterator over the headers