javax.xml.soap

クラスMimeHeaders

java.lang.Object

javax.xml.soap.MimeHeaders

public class MimeHeaders
extends Object

MimeHeaderオブジェクトのコンテナで、メッセージのMIME部分にあるMIMEヘッダーを表します。

このクラスは、主にMIMEヘッダーと値に基づいてアプリケーションに特定の添付を取得させようとするときに使用します。また、このクラスはAttachmentPartや、SAAJ APIのほかのMIME依存部分の実装に多く使用されます。

関連項目:

SOAPMessage.getAttachments(), AttachmentPart

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

コンストラクタ

コンストラクタと説明
MimeHeaders() 空のVectorオブジェクトによって初期化されるデフォルトのMimeHeadersオブジェクトを構築します。

メソッドのサマリー

修飾子と型	メソッドと説明
void	addHeader(String name, String value) 指定の名前と値のMimeHeaderオブジェクトを、このMimeHeadersオブジェクトのヘッダー・リストに追加します。
Iterator	getAllHeaders() このMimeHeadersオブジェクトのすべてのMimeHeaderを返します。
String[]	getHeader(String name) 指定のヘッダーのすべての値をStringオブジェクトの配列として返します。
Iterator	getMatchingHeaders(String[] names) 指定の名前配列にある名前と一致する名前を持つMimeHeaderオブジェクトをすべて返します。
Iterator	getNonMatchingHeaders(String[] names) 指定の名前配列にある名前と一致しない名前を持つMimeHeaderオブジェクトをすべて返します。
void	removeAllHeaders() このMimeHeadersオブジェクトからすべてのヘッダー・エントリを削除します。
void	removeHeader(String name) 指定の名前に一致する名前を持つMimeHeaderオブジェクトをすべて削除します。
void	setHeader(String name, String value) 指定の値に対し、指定の名前が一致する最初のヘッダー・エントリの現在の値を置き換えます。既存のヘッダーで一致するものがない場合、新たにヘッダーを追加します。

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

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

コンストラクタの詳細

MimeHeaders

public MimeHeaders()

空のVectorオブジェクトによって初期化されるデフォルトのMimeHeadersオブジェクトを構築します。

メソッドの詳細

getHeader

public String[] getHeader(String name)

指定のヘッダーのすべての値をStringオブジェクトの配列として返します。

パラメータ:

name - 返される値のヘッダー名

戻り値:

指定のヘッダーのすべての値を持つString配列

関連項目:

setHeader(java.lang.String, java.lang.String)

setHeader

public void setHeader(String name,
                      String value)

指定の値に対し、指定の名前が一致する最初のヘッダー・エントリの現在の値を置き換えます。既存のヘッダーで一致するものがない場合、新たにヘッダーを追加します。このメソッドは、最初の1つの後、一致するヘッダーをすべて削除します。

RFC822ヘッダーはUS-ASCII文字だけを含むことが可能である点に注意してください。

パラメータ:

name - 検索するヘッダー名を持つString

value - 指定のヘッダーの現在の値と置き換える値を持つString

例外:

IllegalArgumentException - 設定するMIMEヘッダー名または値に問題があった場合

関連項目:

getHeader(java.lang.String)

addHeader

public void addHeader(String name,
                      String value)

指定の名前と値のMimeHeaderオブジェクトを、このMimeHeadersオブジェクトのヘッダー・リストに追加します。

RFC822ヘッダーはUS-ASCII文字だけを含むことが可能である点に注意してください。

パラメータ:

name - 追加するヘッダーの名前を持つString

value - 追加するヘッダーの値を持つString

例外:

IllegalArgumentException - 追加するMIMEヘッダー名または値に問題があった場合

removeHeader

public void removeHeader(String name)

指定の名前に一致する名前を持つMimeHeaderオブジェクトをすべて削除します。

パラメータ:

name - 検索するヘッダー名を持つString

removeAllHeaders

public void removeAllHeaders()

このMimeHeadersオブジェクトからすべてのヘッダー・エントリを削除します。

getAllHeaders

public Iterator getAllHeaders()

このMimeHeadersオブジェクトのすべてのMimeHeaderを返します。

戻り値:

MimeHeaderオブジェクトのMimeHeadersオブジェクト・リストのIteratorオブジェクト

getMatchingHeaders

public Iterator getMatchingHeaders(String[] names)

指定の名前配列にある名前と一致する名前を持つMimeHeaderオブジェクトをすべて返します。

パラメータ:

names - 検索する名前を持つStringオブジェクトの配列

戻り値:

指定のリストにある名前の1つと一致するMimeHeaderオブジェクトのIteratorオブジェクト

getNonMatchingHeaders

public Iterator getNonMatchingHeaders(String[] names)

指定の名前配列にある名前と一致しない名前を持つMimeHeaderオブジェクトをすべて返します。

パラメータ:

names - 検索する名前を持つStringオブジェクトの配列

戻り値:

指定のリストにある名前のいずれにも一致しないMimeHeaderオブジェクトのIteratorオブジェクト