Top Description Fields Constructors Methods
org.springframework.http

pack-priv Class ReadOnlyHttpHeaders

extends HttpHeaders
Class Inheritance
Imports
java.util.AbstractMap.SimpleImmutableEntry, .Collection, .Collections, .LinkedHashSet, .List, .Map, .Set, java.util.function.BiConsumer, java.util.stream.Collectors, org.springframework.lang.Nullable, org.springframework.util.MultiValueMap

HttpHeaders object that can only be read, not written to.
Authors
Brian Clozel, Sam Brannen
Since
5.1.1

Field Summary

Modifier and TypeField and Description
private List<MediaType>
private MediaType
private static final long
Inherited from org.springframework.http.HttpHeaders:
ACCEPTACCEPT_CHARSETACCEPT_ENCODINGACCEPT_LANGUAGEACCEPT_PATCHACCEPT_RANGESACCESS_CONTROL_ALLOW_CREDENTIALSACCESS_CONTROL_ALLOW_HEADERSACCESS_CONTROL_ALLOW_METHODSACCESS_CONTROL_ALLOW_ORIGINACCESS_CONTROL_EXPOSE_HEADERSACCESS_CONTROL_MAX_AGEACCESS_CONTROL_REQUEST_HEADERSACCESS_CONTROL_REQUEST_METHODAGEALLOWAUTHORIZATIONCACHE_CONTROLCONNECTIONCONTENT_DISPOSITIONCONTENT_ENCODINGCONTENT_LANGUAGECONTENT_LENGTHCONTENT_LOCATIONCONTENT_RANGECONTENT_TYPECOOKIEDATEEMPTYETAGEXPECTEXPIRESFROMheadersHOSTIF_MATCHIF_MODIFIED_SINCEIF_NONE_MATCHIF_RANGEIF_UNMODIFIED_SINCELAST_MODIFIEDLINKLOCATIONMAX_FORWARDSORIGINPRAGMAPROXY_AUTHENTICATEPROXY_AUTHORIZATIONRANGEREFERERRETRY_AFTERSERVERSET_COOKIESET_COOKIE2TETRAILERTRANSFER_ENCODINGUPGRADEUSER_AGENTVARYVIAWARNINGWWW_AUTHENTICATE

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
add(String
the header name
headerName
,
String
the header value
headerValue
)

Overrides org.springframework.http.HttpHeaders.add.

Implements org.springframework.util.MultiValueMap.add.

Add the given, single header value under the given name.
public void
addAll(String
they key
key
,
List<? extends String>
the values to be added
values
)

Overrides org.springframework.http.HttpHeaders.addAll.

Implements org.springframework.util.MultiValueMap.addAll.

Add all the values of the given list to the current list of values for the given key.
public void
addAll(MultiValueMap<String, String>
the values to be added
values
)

Overrides org.springframework.http.HttpHeaders.addAll.

Implements org.springframework.util.MultiValueMap.addAll.

Add all the values of the given MultiValueMap to the current values.
public void
clear()

Overrides org.springframework.http.HttpHeaders.clear.

Implements java.util.Map.clear.

Removes all of the mappings from this map (optional operation).
public void
clearContentHeaders()

Overrides org.springframework.http.HttpHeaders.clearContentHeaders.

Remove the well-known "Content-*" HTTP headers.
public Set<Map.Entry<String, List<String>>>
entrySet()

Overrides org.springframework.http.HttpHeaders.entrySet.

Implements java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map.
public void
forEach(BiConsumer<? super String, ? super List<String>>
The action to be performed for each entry
action
)

Overrides org.springframework.http.HttpHeaders.forEach.

Overrides default java.util.Map.forEach.

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.
public List<String>
get(Object
the key whose associated value is to be returned
key
)

Overrides org.springframework.http.HttpHeaders.get.

Implements java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
public List<MediaType>
getAccept()

Overrides org.springframework.http.HttpHeaders.getAccept.

Return the list of acceptable media types, as specified by the Accept header.
public MediaType
getContentType()

Overrides org.springframework.http.HttpHeaders.getContentType.

Return the media type of the body, as specified by the Content-Type header.
public Set<String>
keySet()

Overrides org.springframework.http.HttpHeaders.keySet.

Implements java.util.Map.keySet.

Returns a Set view of the keys contained in this map.
public List<String>
put(String
key with which the specified value is to be associated
key
,
List<String>
value to be associated with the specified key
value
)

Overrides org.springframework.http.HttpHeaders.put.

Implements java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation).
public void
putAll(Map<? extends String, ? extends List<String>>
mappings to be stored in this map
map
)

Overrides org.springframework.http.HttpHeaders.putAll.

Implements java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation).
public List<String>
remove(Object
key whose mapping is to be removed from the map
key
)

Overrides org.springframework.http.HttpHeaders.remove.

Implements java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation).
public void
set(String
the header name
headerName
,
String
the header value
headerValue
)

Overrides org.springframework.http.HttpHeaders.set.

Implements org.springframework.util.MultiValueMap.set.

Set the given, single header value under the given name.
public void
setAll(Map<String, String>
the values.
values
)

Overrides org.springframework.http.HttpHeaders.setAll.

Implements org.springframework.util.MultiValueMap.setAll.

Set the given values under.
public Map<String, String>
toSingleValueMap()

Overrides org.springframework.http.HttpHeaders.toSingleValueMap.

Implements org.springframework.util.MultiValueMap.toSingleValueMap.

Return a Map with the first values contained in this MultiValueMap.
public Collection<List<String>>
values()

Overrides org.springframework.http.HttpHeaders.values.

Implements java.util.Map.values.

Returns a Collection view of the values contained in this map.
Inherited from org.springframework.http.HttpHeaders:
containsKeycontainsValueencodeBasicAuthequalsformatDateformatHeadersgetAcceptCharsetgetAcceptLanguagegetAcceptLanguageAsLocalesgetAcceptPatchgetAccessControlAllowCredentialsgetAccessControlAllowHeadersgetAccessControlAllowMethodsgetAccessControlAllowOrigingetAccessControlExposeHeadersgetAccessControlMaxAgegetAccessControlRequestHeadersgetAccessControlRequestMethodgetAllowgetCacheControlgetConnectiongetContentDispositiongetContentLanguagegetContentLengthgetDategetETaggetETagValuesAsListgetExpiresgetFieldValuesgetFirstgetFirstDategetFirstZonedDateTimegetHostgetIfMatchgetIfModifiedSincegetIfNoneMatchgetIfUnmodifiedSincegetLastModifiedgetLocationgetOrEmptygetOrigingetPragmagetRangegetUpgradegetValuesAsListgetVaryhashCodeisEmptyputIfAbsentreadOnlyHttpHeadersreadOnlyHttpHeaderssetAcceptsetAcceptCharsetsetAcceptLanguagesetAcceptLanguageAsLocalessetAcceptPatchsetAccessControlAllowCredentialssetAccessControlAllowHeaderssetAccessControlAllowMethodssetAccessControlAllowOriginsetAccessControlExposeHeaderssetAccessControlMaxAgesetAccessControlMaxAgesetAccessControlRequestHeaderssetAccessControlRequestMethodsetAllowsetBasicAuthsetBasicAuthsetBasicAuthsetBearerAuthsetCacheControlsetCacheControlsetConnectionsetConnectionsetContentDispositionsetContentDispositionFormDatasetContentLanguagesetContentLengthsetContentTypesetDatesetDatesetDatesetDatesetETagsetExpiressetExpiressetExpiressetHostsetIfMatchsetIfMatchsetIfModifiedSincesetIfModifiedSincesetIfModifiedSincesetIfNoneMatchsetIfNoneMatchsetIfUnmodifiedSincesetIfUnmodifiedSincesetIfUnmodifiedSincesetInstantsetLastModifiedsetLastModifiedsetLastModifiedsetLocationsetOriginsetPragmasetRangesetUpgradesetVarysetZonedDateTimesizetoCommaDelimitedStringtoStringwritableHttpHeaders

Field Detail

cachedAcceptback to summary
private List<MediaType> cachedAccept
Annotations
@Nullable
@SuppressWarnings:serial
cachedContentTypeback to summary
private MediaType cachedContentType
Annotations
@Nullable
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.springframework.http.HttpHeaders.serialVersionUID.

Constructor Detail

ReadOnlyHttpHeadersback to summary
pack-priv ReadOnlyHttpHeaders(MultiValueMap<String, String> headers)

Method Detail

addback to summary
public void add(String headerName, String headerValue)

Overrides org.springframework.http.HttpHeaders.add.

Implements org.springframework.util.MultiValueMap.add.

Doc from org.springframework.http.HttpHeaders.add.

Add the given, single header value under the given name.

Parameters
headerName:String

the header name

headerValue:String

the header value

Annotations
@Override
addAllback to summary
public void addAll(String key, List<? extends String> values)

Overrides org.springframework.http.HttpHeaders.addAll.

Implements org.springframework.util.MultiValueMap.addAll.

Doc from org.springframework.util.MultiValueMap.addAll.

Add all the values of the given list to the current list of values for the given key.

Parameters
key:String

they key

values:List<? extends String>

the values to be added

Annotations
@Override
addAllback to summary
public void addAll(MultiValueMap<String, String> values)

Overrides org.springframework.http.HttpHeaders.addAll.

Implements org.springframework.util.MultiValueMap.addAll.

Doc from org.springframework.util.MultiValueMap.addAll.

Add all the values of the given MultiValueMap to the current values.

Parameters
values:MultiValueMap<String, String>

the values to be added

Annotations
@Override
clearback to summary
public void clear()

Overrides org.springframework.http.HttpHeaders.clear.

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Annotations
@Override
clearContentHeadersback to summary
public void clearContentHeaders()

Overrides org.springframework.http.HttpHeaders.clearContentHeaders.

Doc from org.springframework.http.HttpHeaders.clearContentHeaders.

Remove the well-known "Content-*" HTTP headers.

Such headers should be cleared from the response if the intended body can't be written due to errors.

Annotations
@Override
entrySetback to summary
public Set<Map.Entry<String, List<String>>> entrySet()

Overrides org.springframework.http.HttpHeaders.entrySet.

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<Map.Entry<String, List<String>>>

a set view of the mappings contained in this map

Annotations
@Override
forEachback to summary
public void forEach(BiConsumer<? super String, ? super List<String>> action)

Overrides org.springframework.http.HttpHeaders.forEach.

Overrides default java.util.Map.forEach.

Doc from java.util.Map.forEach.

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller.

Parameters
action:BiConsumer<? super String, ? super List<String>>

The action to be performed for each entry

Annotations
@Override
getback to summary
public List<String> get(Object key)

Overrides org.springframework.http.HttpHeaders.get.

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters
key:Object

the key whose associated value is to be returned

Returns:List<String>

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations
@Override
getAcceptback to summary
public List<MediaType> getAccept()

Overrides org.springframework.http.HttpHeaders.getAccept.

Doc from org.springframework.http.HttpHeaders.getAccept.

Return the list of acceptable media types, as specified by the Accept header.

Returns an empty list when the acceptable media types are unspecified.

Annotations
@Override
getContentTypeback to summary
public MediaType getContentType()

Overrides org.springframework.http.HttpHeaders.getContentType.

Doc from org.springframework.http.HttpHeaders.getContentType.

Return the media type of the body, as specified by the Content-Type header.

Returns null when the Content-Type header is not set.

Annotations
@Override
keySetback to summary
public Set<String> keySet()

Overrides org.springframework.http.HttpHeaders.keySet.

Implements java.util.Map.keySet.

Doc from java.util.Map.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<String>

a set view of the keys contained in this map

Annotations
@Override
putback to summary
public List<String> put(String key, List<String> value)

Overrides org.springframework.http.HttpHeaders.put.

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters
key:String

key with which the specified value is to be associated

value:List<String>

value to be associated with the specified key

Returns:List<String>

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Annotations
@Override
putAllback to summary
public void putAll(Map<? extends String, ? extends List<String>> map)

Overrides org.springframework.http.HttpHeaders.putAll.

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters
map:Map<? extends String, ? extends List<String>>

mappings to be stored in this map

Annotations
@Override
removeback to summary
public List<String> remove(Object key)

Overrides org.springframework.http.HttpHeaders.remove.

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters
key:Object

key whose mapping is to be removed from the map

Returns:List<String>

the previous value associated with key, or null if there was no mapping for key.

Annotations
@Override
setback to summary
public void set(String headerName, String headerValue)

Overrides org.springframework.http.HttpHeaders.set.

Implements org.springframework.util.MultiValueMap.set.

Doc from org.springframework.http.HttpHeaders.set.

Set the given, single header value under the given name.

Parameters
headerName:String

the header name

headerValue:String

the header value

Annotations
@Override
setAllback to summary
public void setAll(Map<String, String> values)

Overrides org.springframework.http.HttpHeaders.setAll.

Implements org.springframework.util.MultiValueMap.setAll.

Doc from org.springframework.util.MultiValueMap.setAll.

Set the given values under.

Parameters
values:Map<String, String>

the values.

Annotations
@Override
toSingleValueMapback to summary
public Map<String, String> toSingleValueMap()

Overrides org.springframework.http.HttpHeaders.toSingleValueMap.

Implements org.springframework.util.MultiValueMap.toSingleValueMap.

Doc from org.springframework.util.MultiValueMap.toSingleValueMap.

Return a Map with the first values contained in this MultiValueMap.

Returns:Map<String, String>

a single value representation of this map

Annotations
@Override
valuesback to summary
public Collection<List<String>> values()

Overrides org.springframework.http.HttpHeaders.values.

Implements java.util.Map.values.

Doc from java.util.Map.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<List<String>>

a collection view of the values contained in this map

Annotations
@Override