Класс Headers

Все реализованные интерфейсы:
Map<String,​List<String>>
public class Headers
extends Object
implements Map<String,List<String>>

Заголовки HTTP-запросов и ответов представлены этим классом, реализующим интерфейс Map<String, List <String>>. Ключами являются регистронезависимые строки, представляющие имена заголовков, а значение, связанное с каждым ключом, — List<String>, содержащий по одному элементу для каждого вхождения имени заголовка в запросе или ответе.

Например, если экземпляр заголовка ответа содержит один ключ "HeaderName" со значениями "value1" и "value2", то этот объект выводится как две строки заголовка:

HeaderName: value1
HeaderName: value2

Предоставляются все обычные методы Map, но наиболее часто используются следующие дополнительные методы удобства:

  • getFirst(String) возвращает значение заголовка с одиночным значением или первое значение многозначного заголовка.
  • add(String,String) добавляет указанное значение заголовка в список для данного ключа
  • set(String,String) устанавливает указанное поле заголовка в единственное заданное значение, перезаписывая любые существующие значения в списке значений.

Все методы в этом классе принимают null значения для ключей и значений. Однако null-ключи никогда не будут присутствовать в заголовках HTTP-запросов и не будут выводиться/отправляться в заголовках ответа. Null-значения могут быть представлены как пустой запись для ключа (т. е. список равен null) или, когда ключ имеет список, но одно (или несколько) значение(й) списка равно null. Null-значения выводятся как строка заголовка, содержащая ключ, но без связанного значения.

С:
1.6

Вложенные классы

Вложенные классы/интерфейсы, объявленные в интерфейсе java.util.Map

Map.Entry<K,​V>

Краткое описание конструкторов

Конструктор Описание
Headers()

Краткое описание методов

Модификатор и тип Метод Описание
void add​(String key, String value)

Добавляет заданное значение в список заголовков для заданного ключа.

String getFirst​(String key)

Возвращает первое значение из списка значений String для данного ключа (если хотя бы одно существует).

void set​(String key, String value)

Устанавливает заданное значение как единственное значение заголовка для заданного ключа.

Методы, объявленные в классе java.lang.Object

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

Методы, объявленные в интерфейсе java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Подробное описание конструкторов

Headers

public Headers()

Подробное описание методов

getFirst

public String getFirst(String key)

Возвращает первое значение из списка значений String для данного ключа (если хотя бы одно существует).

Параметры:
key - ключ для поиска
Возвращает:
первое строковое значение, связанное с ключом

add

public void add(String key,
                String value)

Добавляет заданное значение в список заголовков для заданного ключа. Если сопоставление ещё не существует, оно создаётся.

Параметры:
key - имя заголовка
value - значение заголовка для добавления в заголовок

set

public void set(String key,
                String value)

Устанавливает заданное значение как единственное значение заголовка для заданного ключа. Если сопоставление ещё не существует, оно создаётся.

Параметры:
key - имя заголовка
value - значение заголовка для установки.

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.httpserver/com/sun/net/httpserver/Headers.html

Spec-Zone .ru
спецификации, руководства, описания, API