/*
* Copyright 2017-2020 original authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.micronaut.core.type;
Common interface for all mutable header types.
Author: graemerocher Since: 1.0
/**
* Common interface for all mutable header types.
*
* @author graemerocher
* @since 1.0
*/
public interface MutableHeaders extends Headers {
Add a header for the given name and value.
Params: - header – The head name
- value – The value
Returns: This headers object
/**
* Add a header for the given name and value.
*
* @param header The head name
* @param value The value
* @return This headers object
*/
MutableHeaders add(CharSequence header, CharSequence value);
Removes a header.
Params: - header – The header to remove
Returns: These headers
/**
* Removes a header.
*
* @param header The header to remove
* @return These headers
*/
MutableHeaders remove(CharSequence header);
Sets an HTTP header overriding any existing value.
Params: - header – The header
- value – The value
Returns: This headers Since: 1.3.3
/**
* Sets an HTTP header overriding any existing value.
* @param header The header
* @param value The value
* @return This headers
* @since 1.3.3
*/
default MutableHeaders set(CharSequence header, CharSequence value) {
remove(header);
add(header, value);
return this;
}
}