パッケージ jakarta.mail.internet
クラス HeaderTokenizer
- java.lang.ObjectSE
-
- jakarta.mail.internet.HeaderTokenizer
public class HeaderTokenizer extends ObjectSE
このクラスは、RFC822 および MIME ヘッダーを RFC822 および MIME で指定された基本的なシンボルにトークン化します。このクラスは、折り返しヘッダー(つまり、CRLF SPACE シーケンスが埋め込まれたヘッダー)を処理します。折り返しは、返されたトークンから削除されます。
- 作成者:
- John Mani, Bill Shannon
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
HeaderTokenizer.Token
Token クラスは、HeaderTokenizer によって返されるトークンを表します。
コンストラクターのサマリー
コンストラクター コンストラクター 説明 HeaderTokenizer(StringSE header)
コンストラクター。HeaderTokenizer(StringSE header, StringSE delimiters)
コンストラクター。HeaderTokenizer(StringSE header, StringSE delimiters, boolean skipComments)
rfc822 スタイルのヘッダーを取るコンストラクター。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 StringSE
getRemainder()
ヘッダーの残りを返します。HeaderTokenizer.Token
next()
この文字列から次のトークンを解析します。HeaderTokenizer.Token
next(char endOfAtom)
この文字列から次のトークンを解析します。HeaderTokenizer.Token
next(char endOfAtom, boolean keepEscapes)
この文字列から次のトークンを解析します。HeaderTokenizer.Token
peek()
実際にトークンを解析ストリームから削除せずに、次のトークンを確認します。
コンストラクターの詳細
HeaderTokenizer
public HeaderTokenizer(StringSE header, StringSE delimiters, boolean skipComments)
rfc822 スタイルのヘッダーを取るコンストラクター。- パラメーター:
header
- トークン化される rfc822 ヘッダーdelimiters
- ATOMS を区切るために使用する区切り文字のセット。これらは通常RFC822
またはMIME
ですskipComments
- true の場合、コメントはスキップされ、トークンとして返されません
HeaderTokenizer
public HeaderTokenizer(StringSE header, StringSE delimiters)
コンストラクター。コメントは無視され、トークンとして返されません- パラメーター:
header
- トークン化されるヘッダーdelimiters
- 使用する区切り文字
HeaderTokenizer
public HeaderTokenizer(StringSE header)
コンストラクター。RFC822 で定義された区切り文字 -RFC822- は、ATOMS を区切るために使用されます。また、コメントはスキップされ、トークンとして返されません- パラメーター:
header
- ヘッダー文字列
メソッドの詳細
next
public HeaderTokenizer.Token next() throws ParseException
この文字列から次のトークンを解析します。クライアントは、next() を呼び出すループに座って、EOF トークンが返されるまで、連続するトークンを解析します。
- 戻り値:
- 次のトークン
- 例外:
ParseException
- 解析が失敗した場合
next
public HeaderTokenizer.Token next(char endOfAtom) throws ParseException
この文字列から次のトークンを解析します。endOfAtom が NUL でない場合、トークンは endOfAtom 文字が見つかるまで、またはヘッダーの終わりまで拡張されます。このメソッドは、MIME 仕様に準拠していないヘッダーを解析する場合に役立ちます。たとえば、スペースを含むパラメーター値の引用に失敗した場合などです。- パラメーター:
endOfAtom
- NUL でない場合、トークンの終わりを示す文字- 戻り値:
- 次のトークン
- 例外:
ParseException
- 解析が失敗した場合- 導入:
- JavaMail 1.5
next
public HeaderTokenizer.Token next(char endOfAtom, boolean keepEscapes) throws ParseException
この文字列から次のトークンを解析します。endOfAtom は上記のように処理されます。keepEscapes が true の場合、返される文字列ではバックスラッシュエスケープが保持されます。このメソッドは、ファイル名パラメーターでバックスラッシュをエスケープできないなど、MIME 仕様に従わないヘッダーを解析する場合に役立ちます。- パラメーター:
endOfAtom
- NUL でない場合、トークンの終わりを示す文字keepEscapes
- 返される文字列にすべてのバックスラッシュを保持しますか?- 戻り値:
- 次のトークン
- 例外:
ParseException
- 解析が失敗した場合- 導入:
- JavaMail 1.5
peek
public HeaderTokenizer.Token peek() throws ParseException
実際にトークンを解析ストリームから削除せずに、次のトークンを確認します。このメソッドを複数回呼び出すと、next()
が呼び出されるまで、連続したトークンが返されます。- 戻り値:
- 次のトークン
- 例外:
ParseException
- 解析が失敗した場合
getRemainder
public StringSE getRemainder()
ヘッダーの残りを返します。- 戻り値:
- ヘッダーの残りの文字列。すでにヘッダーの終わりにいる場合は null が返されます