Package io.micronaut.core.type

Interface MutableHeaders

All Superinterfaces:

ConversionServiceProvider, ConvertibleMultiValues<String>, ConvertibleValues<List<String>>, Headers, Iterable<Map.Entry<String,List<String>>>, ValueResolver<CharSequence>

All Known Subinterfaces:

MessageHeaders, MutableHttpHeaders

All Known Implementing Classes:

CaseInsensitiveMutableHttpHeaders, NettyHttpHeaders, SimpleHttpHeaders

public interface MutableHeaders
extends Headers

Common interface for all mutable header types.

Since:

1.0

Author:

graemerocher

Field Summary

Fields inherited from interface io.micronaut.core.convert.value.ConvertibleValues

EMPTY

Method Summary

Modifier and Type	Method	Description
MutableHeaders	add(CharSequence header, CharSequence value)	Add a header for the given name and value.
MutableHeaders	remove(CharSequence header)	Removes a header.
default @NonNull MutableHeaders	set(@NonNull CharSequence header, @NonNull CharSequence value)	Sets an HTTP header overriding any existing value.
default @NonNull MutableHeaders	setIfMissing(@NonNull CharSequence header, @NonNull CharSequence value)	Sets an HTTP header if missing.

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleMultiValues

forEach, forEachValue, get, getAll, getFirst, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues

asMap, asMap, asProperties, contains, getConversionService, getValue, getValueType, names, subMap, subMap, subMap, values

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get, get

Method Details

add

MutableHeaders add(CharSequence header,
 CharSequence value)

Add a header for the given name and value.

Parameters:

header - The head name

value - The value

Returns:

This headers object

remove

MutableHeaders remove(CharSequence header)

Removes a header.

Parameters:

header - The header to remove

Returns:

These headers

set

@NonNull
default @NonNull MutableHeaders set(@NonNull
 @NonNull CharSequence header,
 @NonNull
 @NonNull CharSequence value)

Sets an HTTP header overriding any existing value.

Parameters:

header - The header

value - The value

Returns:

This headers

Since:

1.3.3

setIfMissing

@NonNull
default @NonNull MutableHeaders setIfMissing(@NonNull
 @NonNull CharSequence header,
 @NonNull
 @NonNull CharSequence value)

Sets an HTTP header if missing.

Parameters:

header - The header

value - The value

Returns:

This headers

Since:

4.6