Headers (Java HTTP サーバー)

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>> を実装するこのクラスによって表されます。キーはヘッダー名を表す文字列であり大文字と小文字は区別されません。各キーに関連付けられた値は、要求または応答内に出現する各ヘッダー名に対して 1 つの要素を持つ List<String> です。
たとえば、応答ヘッダーのインスタンスに「value1」と「value2」という 2 つの値を持つ 1 つのキー「HeaderName」が含まれている場合、このオブジェクトは 2 つのヘッダー行として出力されます。
```
 HeaderName: value1
 HeaderName: value2
 
```
通常の Map メソッドがすべて提供されますが、次の追加の簡易メソッドがよく使用される可能性があります。
- getFirst(String)。単一値ヘッダーまたは複数値ヘッダーの最初の値を返します。
- add(String,String)。指定されたキーのリストに、指定されたヘッダー値を追加します。
- set(String,String)。指定されたヘッダーフィールドに単一値を設定して、値リストの既存の値をすべて上書きします。
このクラスのどのメソッドでも、キーおよび値で null 値が許容されます。ただし、HTTP 要求ヘッダーに null キーが存在することはなく、応答ヘッダーで出力または送信されることもありません。null 値は、キーの null エントリ (リストが null)、またはキーにリストがあるがリストの 1 つ以上の値が 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)` マップが 1 つまたは複数のキーを指定された値にマッピングしている場合に `true` を返します。
`Set<Map.Entry<String,List<String>>>`	`entrySet()` このマップに含まれるマッピングの `Set` ビューを返します。
`boolean`	`equals(Object o)` このオブジェクトとほかのオブジェクトが等しいかどうかを示します。
`List<String>`	`get(Object key)` 指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合は `null` を返します。
`String`	`getFirst(String key)` 指定されたキーについて、文字列値のリストの最初の値を返します (少なくとも 1 つ存在する場合)。
`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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - Headers
```
public Headers()
```
- メソッドの詳細
  - size
```
public int size()
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    このマップ内のキー値マッピングの数を返します。マップ内に Integer.MAX_VALUE より多くの要素がある場合は、Integer.MAX_VALUE を返します。
    
    定義:
    
    size 、インタフェース: Map<String,List<String>>
    
    戻り値:
    このマップ内のキーと値のマッピングの数
  - isEmpty
```
public boolean isEmpty()
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    このマップがキーと値のマッピングを保持しない場合に true を返します。
    
    定義:
    
    isEmpty 、インタフェース: Map<String,List<String>>
    
    戻り値:
    このマップがキーと値のマッピングを保持しない場合は true
  - containsKey
```
public boolean containsKey(Object key)
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    指定のキーのマッピングがマップに含まれている場合に true を返します。つまり、このマップに、(key==null ? k==null : key.equals(k)) となるキー k が含まれている場合にのみ true を返します。このようなマッピングが 1 つだけあります。
    
    定義:
    
    containsKey 、インタフェース: Map<String,List<String>>
    
    パラメータ:
    key - このマップ内にあるかどうかが判定されるキー
    
    戻り値:
    このマップが指定されたキーのマッピングを保持する場合は true
  - containsValue
```
public boolean containsValue(Object value)
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    マップが 1 つまたは複数のキーを指定された値にマッピングしている場合に true を返します。つまり、このマップに、(value==null ? v==null : value.equals(v)) となる値 v へのマッピングが 1 つ以上ある場合にのみ true を返します。Map インタフェースのほとんどの実装で、このオペレーションにかかる時間はマップのサイズに正比例します。
    
    定義:
    
    containsValue 、インタフェース: Map<String,List<String>>
    
    パラメータ:
    value - このマップにあるかどうかが判定される値
    
    戻り値:
    このマップが 1 つまたは複数のキーを指定された値にマッピングしている場合は true
  - get
```
public List<String> get(Object key)
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    指定されたキーがマップされている値を返します。そのキーのマッピングがこのマップに含まれていない場合は null を返します。
    つまり、このメソッドは、(key==null ? k==null : key.equals(k)) となるキー k から値 v へのマッピングがこのマップに含まれている場合は v を返し、それ以外の場合は null を返します。このようなマッピングが 1 つだけあります。
    このマップが null 値を許可する場合、戻り値の null は、マップがキーのマッピングを保持していないことを示すとはかぎりません。つまり、マップが明示的にキーを null にマップすることもあります。containsKey オペレーションを使うと、こうした 2 つの場合を見分けることができます。
    
    定義:
    
    get 、インタフェース: Map<String,List<String>>
    
    パラメータ:
    key - 関連付けられた値が返されるキー
    
    戻り値:
    指定されたキーがマップされている値。そのキーのマッピングがこのマップに含まれていない場合は null
  - getFirst
```
public String getFirst(String key)
```
    指定されたキーについて、文字列値のリストの最初の値を返します (少なくとも 1 つ存在する場合)。
    
    パラメータ:
    key - 検索するキー
    
    戻り値:
    キーに関連付けられた最初の文字列値
  - put
```
public List<String> put(String key,
               List<String> value)
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    指定された値と指定されたキーをこのマップで関連付けます (オプションの操作)。マップにすでにこのキーに対するマッピングがある場合、古い値は指定された値に置き換えられます。m.containsKey(k) が true を返す場合に限り、マップ m はキー k のマッピングを含むと言えます。
    
    定義:
    
    put 、インタフェース: Map<String,List<String>>
    
    パラメータ:
    key - 指定された値が関連付けられるキー
    value - 指定された鍵に関連付けられる値
    
    戻り値:
    key に以前に関連付けられていた値。key のマッピングが存在しなかった場合は null。(実装が null 値をサポートしている場合、戻り値 null は、以前にマップが null と key を関連付けていたことを示す場合もある)
  - 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)
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    このマップからキーのマッピング (ある場合) を削除します (オプションの操作)。つまり、(key==null ? k==null : key.equals(k)) となるキー k から値 v へのマッピングがこのマップに含まれる場合、このマッピングは削除されます。マップはこのようなマッピングを 1 つだけ含めることができます。
    このマップが以前にこのキーを関連付けていた値を返します。キーに対するマッピングがマップになかった場合は null を返します。
    このマップが null 値を許可する場合、戻り値の null は、マップがキーのマッピングを保持していなかったことを示すとはかぎりません。つまり、マップが明示的にキーを null にマップしていた可能性もあります。
    呼び出しが戻ると、マップは指定されたキーのマッピングを含まなくなります。
    
    定義:
    
    remove 、インタフェース: Map<String,List<String>>
    
    パラメータ:
    key - マッピングがマップから削除されるキー
    
    戻り値:
    key に以前に関連付けられていた値。key のマッピングが存在しなかった場合は null。
  - putAll
```
public void putAll(Map<? extends String,? extends List<String>> t)
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    指定されたマップのすべてのマッピングをこのマップにコピーします (オプションの操作)。この呼び出しの効果は、指定されたマップ内のキー k から値 v へのマッピングごとに、このマップに対して put(k, v) を 1 回呼び出した場合と同じです。オペレーションの進行中に、指定されたマップが変更された場合の、このオペレーションの動作は定義されていません。
    
    定義:
    
    putAll 、インタフェース: Map<String,List<String>>
    
    パラメータ:
    t - このマップに格納されるマッピング
  - clear
```
public void clear()
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    マップからマッピングをすべて削除します (オプションの操作)。この呼び出しが戻ると、マップは空になります。
    
    定義:
    
    clear 、インタフェース: Map<String,List<String>>
  - keySet
```
public Set<String> keySet()
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    このマップに含まれるキーの Set ビューを返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されていません (イテレータ自身の remove オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートしていません。
    
    定義:
    
    keySet 、インタフェース: Map<String,List<String>>
    
    戻り値:
    マップに含まれているキーのセットビュー
  - values
```
public Collection<List<String>> values()
```
    次のインタフェースからコピーされた説明: java.util.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()
```
    次のインタフェースからコピーされた説明: java.util.Map
    
    このマップに含まれるマッピングの Set ビューを返します。セットはマップと連動しているので、マップに対する変更はセットに反映され、また、セットに対する変更はマップに反映されます。セットの反復処理中にマップが変更された場合、反復処理の結果は定義されません (イテレータ自身の remove オペレーション、またはイテレータにより返されるマップエントリに対する setValue オペレーションを除く)。セットは要素の削除をサポートします。Iterator.remove、Set.remove、removeAll、retainAll、および clear オペレーションで対応するマッピングをマップから削除します。add または addAll オペレーションはサポートしていません。
    
    定義:
    
    entrySet 、インタフェース: Map<String,List<String>>
    
    戻り値:
    マップ内に保持されているマッピングのセットビュー
  - equals
```
public boolean equals(Object o)
```
    次のクラスからコピーされた説明: java.lang.Object
    このオブジェクトとほかのオブジェクトが等しいかどうかを示します。
    equals メソッドは、null 以外のオブジェクト参照での同値関係を実装します。
    - 反射性 (reflexive): null 以外の参照値 x について、x.equals(x) は true を返します。
    - 対称性 (symmetric): null 以外の参照値 x および y について、y.equals(x) が true を返す場合に限り、x.equals(y) は true を返します。
    - 推移性 (transitive): null 以外の参照値 x、y、および z について、x.equals(y) が true を返し、y.equals(z) が true を返す場合、x.equals(z) は true を返します。
    - 一貫性 (consistent): null 以外の参照値 x および y について、x.equals(y) の複数の呼び出しは、このオブジェクトに対する equals による比較で使われた情報が変更されていなければ、一貫して true を返すか、一貫して false を返します。
    - null 以外の参照値 x について、x.equals(null) は false を返します。
    Object クラスの equals メソッドは、もっとも比較しやすいオブジェクトの同値関係を実装します。つまり、null 以外の参照値 x と y について、このメソッドは x と y が同じオブジェクトを参照する (x == y が true) 場合にだけ true を返します。
    通常、このメソッドをオーバーライドする場合は、hashCode メソッドを常にオーバーライドして、「等価なオブジェクトは等価なハッシュコードを保持する必要がある」という hashCode メソッドの汎用規約に従う必要があることに留意してください。
    定義:
    
    equals 、インタフェース: Map<String,List<String>>
    
    オーバーライド:
    
    equals 、クラス: Object
    
    パラメータ:
    o - 比較対象の参照オブジェクト。
    
    戻り値:
    このオブジェクトが obj 引数と同じである場合は true、それ以外の場合は false。
    関連項目:
    Object.hashCode(), HashMap
  - hashCode
```
public int hashCode()
```
    次のクラスからコピーされた説明: java.lang.Object
    オブジェクトのハッシュコード値を返します。このメソッドは、HashMap によって提供されるハッシュテーブルなどの、ハッシュテーブルの利点のためにサポートされています。
    hashCode の一般的な規則は次のとおりです。
    - Java アプリケーションの実行中に同じオブジェクトに対して複数回呼び出された場合は常に、このオブジェクトに対する equals の比較で使用される情報が変更されていなければ、hashCode メソッドは常に同じ整数を返す必要があります。ただし、この整数は同じアプリケーションの実行ごとに同じである必要はありません。
    - equals(Object) メソッドに従って 2 つのオブジェクトが等しい場合は、2 つの各オブジェクトに対する hashCode メソッドの呼び出しによって同じ整数の結果が生成される必要があります。
    - Object.equals(java.lang.Object) メソッドに従って 2 つのオブジェクトが等しくない場合は、2 つの各オブジェクトに対する hashCode メソッドの呼び出しによって異なる整数の結果が生成される必要はありません。ただし、プログラマは、等しくないオブジェクトに対して異なる整数の結果を生成すると、ハッシュテーブルのパフォーマンスが向上する可能性があることに注意するようにしてください。
    クラス Object によって定義された hashCode メソッドは、可能なかぎり、異なるオブジェクトに対して異なる整数を返します。(これは通常、オブジェクトの内部アドレスを整数に変換することによって実装されますが、この実装テクニックは Java^TM プログラミング言語では必要ありません。)
    定義:
    
    hashCode 、インタフェース: Map<String,List<String>>
    
    オーバーライド:
    
    hashCode 、クラス: Object
    
    戻り値:
    このオブジェクトのハッシュコード値。
    関連項目:
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

クラス Headers

ネストされたクラスのサマリー

インタフェース java.util.Map から継承されたネストされたクラス/インタフェース

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

コンストラクタの詳細

Headers

メソッドの詳細

size

isEmpty

containsKey

containsValue

get

getFirst

put

add

set

remove

putAll

clear

keySet

values

entrySet

equals

hashCode