Заголовки класса

java.lang.Object

com.sun.net.httpserver.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. Нулевые значения выводятся как строка заголовка, содержащая ключ, но без связанного значения.

С:: 1.6

Краткое описание вложенных классов

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

Map.Entry<K,V>

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

Конструктор	Описание
`Headers()`	Создаёт пустой экземпляр `Headers`.

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

Модификатор и тип	Метод	Описание
`void`	`add(String key, String value)`	Добавляет заданное значение в список заголовков для заданного ключа.
`void`	`clear()`	Удаляет все сопоставления из этой карты (необязательная операция).
`boolean`	`containsKey(Object key)`	Возвращает `true`, если эта карта содержит сопоставление для указанного ключа.
`boolean`	`containsValue(Object value)`	Возвращает `true`, если эта карта сопоставляет один или несколько ключей со значением.
`Set<Map.Entry<String,List<String>>>`	`entrySet()`	Возвращает представление `Set` отображений, содержащихся в этой карте.
`boolean`	`equals(Object o)`	Указывает, является ли другой объект "равным" данному.
`List<String>`	`get(Object key)`	Возвращает значение, которому сопоставлен указанный ключ, или `null` , если в этой карте нет сопоставления для ключа.
`String`	`getFirst(String key)`	Возвращает первое значение из `List` значений `String` для заданного ключа (если хотя бы одно существует).
`int`	`hashCode()`	Возвращает значение хэш-кода для объекта.
`boolean`	`isEmpty()`	Возвращает `true`, если в этой карте нет сопоставлений ключ-значение.
`Set<String>`	`keySet()`	Возвращает представление `Set` ключей, содержащихся в этой карте.
`List<String>`	`put(String key, List<String> value)`	Сопоставляет указанное значение с указанным ключом в этой карте (необязательная операция).
`void`	`putAll(Map<? extends String,? extends List<String>> t)`	Копирует все сопоставления из указанной карты в эту карту (необязательная операция).
`List<String>`	`remove(Object key)`	Удаляет сопоставление для ключа из этой карты, если оно присутствует (необязательная операция).
`void`	`set(String key, String value)`	Устанавливает заданное значение в качестве единственного значения заголовка для заданного ключа.
`int`	`size()`	Возвращает количество сопоставлений ключ-значение в этой карте.
`Collection<List<String>>`	`values()`	Возвращает представление `Collection` значений, содержащихся в этой карте.

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

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

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

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

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

Конструктор

public Headers()

Создаёт пустой экземпляр Headers.

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

size

public int size()

Описание скопировано из интерфейса: Map

Возвращает количество пар ключ-значение в этом отображении. Если отображение содержит более чем Integer.MAX_VALUE элементов, возвращает Integer.MAX_VALUE.

Указано в:: size в интерфейсе Map<String,List<String>>
Возвращает:: количество пар ключ-значение в этом отображении

isEmpty

public boolean isEmpty()

Описание скопировано из интерфейса: Map

Возвращает true , если это отображение не содержит пар ключ-значение.

Указано в:: isEmpty в интерфейсе Map<String,List<String>>
Возвращает:: true , если это отображение не содержит пар ключ-значение

containsKey

public boolean containsKey(Object key)

Описание скопировано из интерфейса: Map

Возвращает true , если это отображение содержит отображение для указанного ключа. Более формально, возвращает true тогда и только тогда, когда это отображение содержит отображение для ключа k такого, что Objects.equals(key, k). (Может быть не более одного такого отображения.)

Указано в:: containsKey в интерфейсе Map<String,List<String>>
Параметры:: key - ключ, присутствие которого в этом отображении требуется проверить
Возвращает:: true , если это отображение содержит отображение для указанного ключа

containsValue

public boolean containsValue(Object value)

Описание скопировано из интерфейса: Map

Возвращает true , если это отображение отображает один или несколько ключей на указанное значение. Более формально, возвращает true тогда и только тогда, когда это отображение содержит по меньшей мере одно отображение в значение v такое, что Objects.equals(value, v). Эта операция, вероятно, потребует времени, линейного по размеру отображения, для большинства реализаций интерфейса Map.

Указано в:: containsValue в интерфейсе Map<String,List<String>>
Параметры:: value - значение, присутствие которого в этом отображении требуется проверить
Возвращает:: true , если это отображение отображает один или несколько ключей на указанное значение

get

public List<String> get(Object key)

Описание скопировано из интерфейса: Map

Возвращает значение, которому соответствует указанный ключ, или null , если это отображение не содержит отображения для ключа.

Более формально, если это отображение содержит отображение от ключа k до значения v , таким, что Objects.equals(key, k), то этот метод возвращает v; в противном случае он возвращает null. (Может быть не более одного такого отображения.)

Если это отображение допускает нулевые значения, то возвращаемое значение null не обязательно указывает, что отображение не содержит отображения для ключа; также возможно, что отображение явно отображает ключ на null. Операция containsKey может использоваться для различения этих двух случаев.

Указано в:: get в интерфейсе Map<String,List<String>>
Параметры:: key - ключ, связанное значение которого требуется вернуть
Возвращает:: значение, которому соответствует указанный ключ, или null , если это отображение не содержит отображения для ключа

getFirst

public String getFirst(String key)

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

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

put

public List<String> put(String key, List<String> value)

Описание скопировано из интерфейса: Map

Связывает указанное значение с указанным ключом в этом отображении (дополнительная операция). Если отображение ранее содержало отображение для ключа, старое значение заменяется указанным значением. (Отображение m считается содержащим отображение для ключа k тогда и только тогда, когда m.containsKey(k) вернёт true.)

Указано в:: put в интерфейсе Map<String,List<String>>
Параметры:: key - ключ, с которым должно быть связано указанное значение; value - значение, которое должно быть связано с указанным ключом
Возвращает:: предыдущее значение, связанное с key, или null , если для key не было отображения. (Возвращение null также может указывать, что отображение ранее связывало null с key, если реализация поддерживает null значения.)

add

public void add(String key, String value)

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

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

set

public void set(String key, String value)

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

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

remove

public List<String> remove(Object key)

Описание скопировано из интерфейса: Map

Удаляет отображение для ключа из этого отображения, если оно присутствует (дополнительная операция). Более формально, если это отображение содержит отображение от ключа k к значению v , таким, что Objects.equals(key, k), это отображение удаляется. (Отображение может содержать не более одного такого отображения.)

Возвращает значение, которое это отображение ранее связало с ключом, или null , если в отображении не было отображения для ключа.

Если это отображение допускает нулевые значения, то возвращаемое значение null не обязательно указывает, что отображение не содержало отображения для ключа; также возможно, что отображение явно отображало ключ на null.

Отображение не будет содержать отображения для указанного ключа после возврата вызова.

Указано в:: remove в интерфейсе Map<String,List<String>>
Параметры:: key - ключ, отображение которого нужно удалить из отображения
Возвращает:: предыдущее значение, связанное с key, или null , если для key не было отображения.

putAll

public void putAll(Map<? extends String,? extends List<String>> t)

Описание скопировано из интерфейса: Map

Копирует все отображения из указанного отображения в это отображение (дополнительная операция). Эффект этого вызова эквивалентен вызову put(k, v) для этого отображения один раз для каждого отображения от ключа k к значению v в указанном отображении. Поведение этой операции не определено, если указанное отображение изменяется во время выполнения операции.

Указано в:: putAll в интерфейсе Map<String,List<String>>
Параметры:: t - отображения, которые должны быть сохранены в этом отображении

clear

public void clear()

Описание скопировано из интерфейса: Map

Удаляет все отображения из этого отображения (дополнительная операция). Отображение будет пустым после возврата этого вызова.

Указано в:: clear в интерфейсе Map<String,List<String>>

keySet

public Set<String> keySet()

Описание скопировано из интерфейса: Map

Возвращает Set представление ключей, содержащихся в этом отображении. Множество подкрепляется отображением, поэтому изменения в отображении отражаются в множестве, и наоборот. Если отображение изменяется во время итерации по множеству (кроме собственной операции итератора remove), результаты итерации не определены. Множество поддерживает удаление элементов, которое удаляет соответствующее отображение из отображения, через операции Iterator.remove, Set.remove, removeAll, retainAll, и clear. Оно не поддерживает операции add или addAll.

Указано в:: keySet в интерфейсе Map<String,List<String>>
Возвращает:: множество, представляющее ключи, содержащиеся в этом отображении

values

public Collection<List<String>> values()

Описание скопировано из интерфейса: Map

Возвращает представление Collection значений, содержащихся в этом отображении. Коллекция поддерживается отображением, поэтому изменения в отображении отражаются в коллекции, и наоборот. Если отображение изменяется во время итерации по коллекции (кроме операций самого итератора remove), результаты итерации не определены. Коллекция поддерживает удаление элементов, что удаляет соответствующее отображение из отображения, с помощью операций Iterator.remove, Collection.remove, removeAll, retainAll и clear. Она не поддерживает операции add или addAll.

Указано в:: values в интерфейсе Map<String,List<String>>
Возвращает:: представление коллекции значений, содержащихся в этом отображении

entrySet

public Set<Map.Entry<String,List<String>>> entrySet()

Описание скопировано из интерфейса: Map

Возвращает представление Set отображений, содержащихся в этом отображении. Множество поддерживается отображением, поэтому изменения в отображении отражаются в множестве, и наоборот. Если отображение изменяется во время итерации по множеству (кроме операций самого итератора remove, или операции setValue на элементе отображения, возвращённом итератором), результаты итерации не определены. Множество поддерживает удаление элементов, что удаляет соответствующее отображение из отображения, с помощью операций Iterator.remove, Set.remove, removeAll, retainAll и clear. Оно не поддерживает операции add или addAll.

Указано в:: entrySet в интерфейсе Map<String,List<String>>
Возвращает:: представление множества отображений, содержащихся в этом отображении

equals

public boolean equals(Object o)

Описание скопировано из класса: Object

Указывает, является ли другой объект "равным" данному.

Метод equals реализует отношение эквивалентности на ссылках на объекты, отличных от null:

Он рефлексивен: для любого значения ссылки на объект, отличного от null, x, x.equals(x) должно возвращать true.
Он симметричен: для любых значений ссылок на объекты, отличных от null, x и y, x.equals(y) должно возвращать true тогда и только тогда, когда y.equals(x) возвращает true.
Он транзитивен: для любых значений ссылок на объекты, отличных от null, x, y, и z, если x.equals(y) возвращает true и y.equals(z) возвращает true, то x.equals(z) должно возвращать true.
Он постоянен: для любых значений ссылок на объекты, отличных от null, x и y, многократные вызовы x.equals(y) последовательно возвращают true или последовательно возвращают false, при условии, что никакая информация, используемая в сравнениях equals объектов, не модифицируется.
Для любого значения ссылки на объект, отличного от null, x, x.equals(null) должно возвращать false.

Отношение эквивалентности разбивает элементы, над которыми оно работает, на классы эквивалентности; все члены класса эквивалентности равны друг другу. Члены класса эквивалентности взаимозаменяемы, по крайней мере, для некоторых целей.

Указано в:

equals в интерфейсе Map<String,List<String>>

Переопределяет:

equals в классе Object

Параметры:

o - объект-ссылка для сравнения.

Возвращает:

true если этот объект такой же, как аргумент obj; false в противном случае.

См. также:

hashCode

public int hashCode()

Описание скопировано из класса: Object

Возвращает значение кода хеширования для объекта. Этот метод поддерживается для использования в таблицах хеширования, таких как предоставляемые HashMap.

Общее соглашение о hashCode таково:

Всякий раз, когда он вызывается для одного и того же объекта более одного раза во время выполнения Java-приложения, метод hashCode должен последовательно возвращать то же целое число, при условии, что никакая информация, используемая в сравнениях equals объекта, не модифицируется. Это целое число не обязательно должно оставаться неизменным от одного выполнения приложения к другому выполнению того же приложения.
Если два объекта равны в соответствии с методом equals, то вызов метода hashCode для каждого из двух объектов должен возвращать одинаковый результат.
Не требуется, чтобы если два объекта не равны в соответствии с методом equals, то вызов метода hashCode для каждого из двух объектов должен возвращать различные целые числа. Однако разработчик должен понимать, что получение различных целых чисел для неравных объектов может улучшить производительность хэш-таблиц.

Указано в:

hashCode в интерфейсе Map<String,List<String>>

Переопределяет:

hashCode в классе Object

Возвращает:

значение кода хеширования для этого объекта.

См. также:

© 1993, 2021, 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/17/docs/api/jdk.httpserver/com/sun/net/httpserver/Headers.html