io.netty.handler.codec.http

类 ReadOnlyHttpHeaders

java.lang.Object

io.netty.handler.codec.http.HttpHeaders

io.netty.handler.codec.http.ReadOnlyHttpHeaders

所有已实现的接口:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>

@UnstableApi
public final class ReadOnlyHttpHeaders
extends HttpHeaders

A variant of HttpHeaders which only supports read-only methods.

Any array passed to this class may be used directly in the underlying data structures of this class. If these arrays may be modified it is the caller's responsibility to supply this class with a copy of the array.

This may be a good alternative to DefaultHttpHeaders if your have a fixed set of headers which will not change.

嵌套类概要

从类继承的嵌套类/接口 io.netty.handler.codec.http.HttpHeaders

HttpHeaders.Names, HttpHeaders.Values

字段概要

从类继承的字段 io.netty.handler.codec.http.HttpHeaders

EMPTY_HEADERS

构造器概要

构造器

构造器和说明
ReadOnlyHttpHeaders(boolean validateHeaders, java.lang.CharSequence... nameValuePairs) Create a new instance.

方法概要

限定符和类型	方法和说明
HttpHeaders	add(java.lang.String name, java.lang.Iterable<?> values)
HttpHeaders	add(java.lang.String name, java.lang.Object value)
HttpHeaders	addInt(java.lang.CharSequence name, int value) Add the name to value.
HttpHeaders	addShort(java.lang.CharSequence name, short value) Add the name to value.
HttpHeaders	clear() Removes all headers from this HttpMessage.
boolean	contains(java.lang.String name)
boolean	contains(java.lang.String name, java.lang.String value, boolean ignoreCase)
boolean	containsValue(java.lang.CharSequence name, java.lang.CharSequence value, boolean ignoreCase) Returns true if a header with the name and value exists, false otherwise.
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	entries() Returns a new List that contains all headers in this object.
java.lang.String	get(java.lang.String name)
java.util.List<java.lang.String>	getAll(java.lang.String name)
java.lang.Integer	getInt(java.lang.CharSequence name) Returns the integer value of a header with the specified name.
int	getInt(java.lang.CharSequence name, int defaultValue) Returns the integer value of a header with the specified name.
java.lang.Short	getShort(java.lang.CharSequence name) Returns the short value of a header with the specified name.
short	getShort(java.lang.CharSequence name, short defaultValue) Returns the short value of a header with the specified name.
java.lang.Long	getTimeMillis(java.lang.CharSequence name) Returns the date value of a header with the specified name.
long	getTimeMillis(java.lang.CharSequence name, long defaultValue) Returns the date value of a header with the specified name.
boolean	isEmpty() Checks if no header exists.
java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>>	iterator()
java.util.Iterator<java.util.Map.Entry<java.lang.CharSequence,java.lang.CharSequence>>	iteratorCharSequence()
java.util.Set<java.lang.String>	names() Returns a new Set that contains the names of all headers in this object.
HttpHeaders	remove(java.lang.String name)
HttpHeaders	set(java.lang.String name, java.lang.Iterable<?> values)
HttpHeaders	set(java.lang.String name, java.lang.Object value)
HttpHeaders	setInt(java.lang.CharSequence name, int value) Set the name to value.
HttpHeaders	setShort(java.lang.CharSequence name, short value) Set the name to value.
int	size() Returns the number of headers in this object.
java.util.Iterator<java.lang.CharSequence>	valueCharSequenceIterator(java.lang.CharSequence name) Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.
java.util.Iterator<java.lang.String>	valueStringIterator(java.lang.CharSequence name) Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.

从类继承的方法 io.netty.handler.codec.http.HttpHeaders

add, add, add, addDateHeader, addDateHeader, addHeader, addHeader, addIntHeader, addIntHeader, clearHeaders, contains, contains, copy, encodeAscii, equalsIgnoreCase, get, get, getAll, getAllAsString, getAsString, getContentLength, getContentLength, getDate, getDate, getDateHeader, getDateHeader, getDateHeader, getDateHeader, getHeader, getHeader, getHeader, getHeader, getHost, getHost, getIntHeader, getIntHeader, getIntHeader, getIntHeader, is100ContinueExpected, isContentLengthSet, isKeepAlive, isTransferEncodingChunked, iteratorAsString, newEntity, remove, removeHeader, removeHeader, removeTransferEncodingChunked, set, set, set, set100ContinueExpected, set100ContinueExpected, setAll, setContentLength, setDate, setDateHeader, setDateHeader, setDateHeader, setDateHeader, setHeader, setHeader, setHeader, setHeader, setHost, setHost, setIntHeader, setIntHeader, setIntHeader, setIntHeader, setKeepAlive, setTransferEncodingChunked, toString

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

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

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

forEach, spliterator

构造器详细资料

ReadOnlyHttpHeaders

public ReadOnlyHttpHeaders(boolean validateHeaders,
                           java.lang.CharSequence... nameValuePairs)

Create a new instance.

参数:

validateHeaders - true to validate the contents of each header name.

nameValuePairs - An array of the structure [<name,value>,<name,value>,...]. A copy will NOT be made of this array. If the contents of this array may be modified externally you are responsible for passing in a copy.

方法详细资料

get

public java.lang.String get(java.lang.String name)

指定者:

get 在类中 HttpHeaders

另请参阅:

HttpHeaders.get(CharSequence)

getInt

public java.lang.Integer getInt(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Returns the integer value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getInt 在类中 HttpHeaders

参数:

name - the name of the header to search

返回:

the first header value if the header is found and its value is an integer. null if there's no such header or its value is not an integer.

getInt

public int getInt(java.lang.CharSequence name,
                  int defaultValue)

从类复制的说明: HttpHeaders

Returns the integer value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getInt 在类中 HttpHeaders

参数:

name - the name of the header to search

defaultValue - the default value

返回:

the first header value if the header is found and its value is an integer. defaultValue if there's no such header or its value is not an integer.

getShort

public java.lang.Short getShort(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Returns the short value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getShort 在类中 HttpHeaders

参数:

name - the name of the header to search

返回:

the first header value if the header is found and its value is a short. null if there's no such header or its value is not a short.

getShort

public short getShort(java.lang.CharSequence name,
                      short defaultValue)

从类复制的说明: HttpHeaders

Returns the short value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getShort 在类中 HttpHeaders

参数:

name - the name of the header to search

defaultValue - the default value

返回:

the first header value if the header is found and its value is a short. defaultValue if there's no such header or its value is not a short.

getTimeMillis

public java.lang.Long getTimeMillis(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Returns the date value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getTimeMillis 在类中 HttpHeaders

参数:

name - the name of the header to search

返回:

the first header value if the header is found and its value is a date. null if there's no such header or its value is not a date.

getTimeMillis

public long getTimeMillis(java.lang.CharSequence name,
                          long defaultValue)

从类复制的说明: HttpHeaders

Returns the date value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

指定者:

getTimeMillis 在类中 HttpHeaders

参数:

name - the name of the header to search

defaultValue - the default value

返回:

the first header value if the header is found and its value is a date. defaultValue if there's no such header or its value is not a date.

getAll

public java.util.List<java.lang.String> getAll(java.lang.String name)

指定者:

getAll 在类中 HttpHeaders

另请参阅:

HttpHeaders.getAll(CharSequence)

entries

public java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> entries()

从类复制的说明: HttpHeaders

Returns a new List that contains all headers in this object. Note that modifying the returned List will not affect the state of this object. If you intend to enumerate over the header entries only, use HttpHeaders.iterator() instead, which has much less overhead.

指定者:

entries 在类中 HttpHeaders

另请参阅:

HttpHeaders.iteratorCharSequence()

contains

public boolean contains(java.lang.String name)

指定者:

contains 在类中 HttpHeaders

另请参阅:

HttpHeaders.contains(CharSequence)

contains

public boolean contains(java.lang.String name,
                        java.lang.String value,
                        boolean ignoreCase)

覆盖:

contains 在类中 HttpHeaders

另请参阅:

HttpHeaders.contains(CharSequence, CharSequence, boolean)

containsValue

public boolean containsValue(java.lang.CharSequence name,
                             java.lang.CharSequence value,
                             boolean ignoreCase)

从类复制的说明: HttpHeaders

Returns true if a header with the name and value exists, false otherwise. This also handles multiple values that are separated with a ,.

If ignoreCase is true then a case insensitive compare is done on the value.

覆盖:

containsValue 在类中 HttpHeaders

参数:

name - the name of the header to find

value - the value of the header to find

ignoreCase - true then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values.

valueStringIterator

public java.util.Iterator<java.lang.String> valueStringIterator(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.

覆盖:

valueStringIterator 在类中 HttpHeaders

参数:

name - the name of the header to retrieve

返回:

an Iterator of header values corresponding to name.

valueCharSequenceIterator

public java.util.Iterator<java.lang.CharSequence> valueCharSequenceIterator(java.lang.CharSequence name)

从类复制的说明: HttpHeaders

Equivalent to HttpHeaders.getAll(String) but it is possible that no intermediate list is generated.

覆盖:

valueCharSequenceIterator 在类中 HttpHeaders

参数:

name - the name of the header to retrieve

返回:

an Iterator of header values corresponding to name.

iterator

public java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>> iterator()

指定者:

iterator 在接口中 java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>

指定者:

iterator 在类中 HttpHeaders

iteratorCharSequence

public java.util.Iterator<java.util.Map.Entry<java.lang.CharSequence,java.lang.CharSequence>> iteratorCharSequence()

指定者:

iteratorCharSequence 在类中 HttpHeaders

返回:

Iterator over the name/value header pairs.

isEmpty

public boolean isEmpty()

从类复制的说明: HttpHeaders

Checks if no header exists.

指定者:

isEmpty 在类中 HttpHeaders

size

public int size()

从类复制的说明: HttpHeaders

Returns the number of headers in this object.

指定者:

size 在类中 HttpHeaders

names

public java.util.Set<java.lang.String> names()

从类复制的说明: HttpHeaders

Returns a new Set that contains the names of all headers in this object. Note that modifying the returned Set will not affect the state of this object. If you intend to enumerate over the header entries only, use HttpHeaders.iterator() instead, which has much less overhead.

指定者:

names 在类中 HttpHeaders

add

public HttpHeaders add(java.lang.String name,
                       java.lang.Object value)

指定者:

add 在类中 HttpHeaders

另请参阅:

HttpHeaders.add(CharSequence, Object)

add

public HttpHeaders add(java.lang.String name,
                       java.lang.Iterable<?> values)

指定者:

add 在类中 HttpHeaders

另请参阅:

HttpHeaders.add(CharSequence, Iterable)

addInt

public HttpHeaders addInt(java.lang.CharSequence name,
                          int value)

从类复制的说明: HttpHeaders

Add the name to value.

指定者:

addInt 在类中 HttpHeaders

参数:

name - The name to modify

value - The value

返回:

this

addShort

public HttpHeaders addShort(java.lang.CharSequence name,
                            short value)

从类复制的说明: HttpHeaders

Add the name to value.

指定者:

addShort 在类中 HttpHeaders

参数:

name - The name to modify

value - The value

返回:

this

set

public HttpHeaders set(java.lang.String name,
                       java.lang.Object value)

指定者:

set 在类中 HttpHeaders

另请参阅:

HttpHeaders.set(CharSequence, Object)

set

public HttpHeaders set(java.lang.String name,
                       java.lang.Iterable<?> values)

指定者:

set 在类中 HttpHeaders

另请参阅:

HttpHeaders.set(CharSequence, Iterable)

setInt

public HttpHeaders setInt(java.lang.CharSequence name,
                          int value)

从类复制的说明: HttpHeaders

Set the name to value. This will remove all previous values associated with name.

指定者:

setInt 在类中 HttpHeaders

参数:

name - The name to modify

value - The value

返回:

this

setShort

public HttpHeaders setShort(java.lang.CharSequence name,
                            short value)

从类复制的说明: HttpHeaders

Set the name to value. This will remove all previous values associated with name.

指定者:

setShort 在类中 HttpHeaders

参数:

name - The name to modify

value - The value

返回:

this

remove

public HttpHeaders remove(java.lang.String name)

指定者:

remove 在类中 HttpHeaders

另请参阅:

HttpHeaders.remove(CharSequence)

clear

public HttpHeaders clear()

从类复制的说明: HttpHeaders

Removes all headers from this HttpMessage.

指定者:

clear 在类中 HttpHeaders

返回:

this