パッケージ jakarta.mail.internet

クラス ParameterList

  • public class ParameterList
extends ObjectSE
    このクラスは、MIME パラメーター（属性と値のペア）を保持します。mail.mime.encodeparameters および mail.mime.decodeparameters システムプロパティは、RFC 2231 で指定されたエンコードされたパラメーターがサポートされるかどうかを制御します。デフォルトでは、このようなエンコードされたパラメーターが サポートされています。

    また、現在の実装では、システムプロパティ mail.mime.decodeparameters.strict を "true" に設定すると、エンコードされたパラメーターのデコード中に検出されたエラーに対して ParseException がスローされます。デフォルトでは、デコードエラーが発生した場合、元の（デコードされていない）文字列が使用されます。

    現在の実装では、システムプロパティ mail.mime.parameters.strict がサポートされています。これは、パラメーターリストの解析時に false に設定すると、引用符なしでパラメーター値に空白やその他の特殊文字を含めることができます。パラメーター値は次のセミコロンで終了します。true（デフォルト）に設定した場合、パラメーター値は MIME 仕様に準拠する必要があり、空白または特殊文字が含まれている場合は引用符で囲む必要があります。

    作成者:
    John Mani, Bill Shannon

    • コンストラクターの詳細

      • ParameterList

        public ParameterList()
        引数なしのコンストラクター。

      • ParameterList

        public ParameterList​(StringSE s)
              throws ParseException
        パラメーターリストの文字列を受け取るコンストラクター。文字列が解析され、パラメーターが収集されて内部に保存されます。解析が失敗した場合、ParseException がスローされます。空のパラメーターリスト文字列は有効であり、解析されて空の ParameterList になることに注意してください。
        パラメーター:
        s - パラメーターリスト文字列。
        例外:
        ParseException - 解析が失敗した場合。

    • メソッドの詳細

      • combineSegments

        public void combineSegments()
        このクラスの通常のユーザーは、単純なパラメーター名を使用します。場合によっては、たとえば、IMAP プロトコルメッセージを処理するときに、マルチセグメント名（RFC 2231 で指定）の個々のセグメントが検出され、set(java.lang.String, java.lang.String) メソッドに渡されます。これらすべてのセグメントがこの ParameterList に追加された後、論理パラメーターの名前と値を表すために組み合わせる必要があります。このメソッドは、マルチセグメント名のすべてのセグメントを結合します。

        通常のユーザーは、このメソッドを呼び出す必要はありません。

        導入:
        JavaMail 1.5

      • size

        public int size()
        このリスト内のパラメーターの数を返します。
        戻り値:
        パラメーター数。

      • get

        public StringSE get​(StringSE name)
        指定されたパラメーターの値を返します。パラメーター名は大文字と小文字を区別しないことに注意してください。
        パラメーター:
        name - パラメーター名。
        戻り値:
        パラメーターの値。パラメーターが存在しない場合、null を返します。

      • set

        public void set​(StringSE name,
                StringSE value)
        パラメーターを設定します。このパラメーターがすでに存在する場合は、この新しい値に置き換えられます。
        パラメーター:
        name - パラメーターの名前。
        value - パラメーターの値。

      • set

        public void set​(StringSE name,
                StringSE value,
                StringSE charset)
        パラメーターを設定します。このパラメーターがすでに存在する場合は、この新しい値に置き換えられます。mail.mime.encodeparameters システムプロパティが true で、パラメーター値が非 ASCII の場合、RFC 2231 で指定されているように、指定された文字セットでエンコードされます。
        パラメーター:
        name - パラメーターの名前。
        value - パラメーターの値。
        charset - パラメーター値の文字セット。
        導入:
        JavaMail 1.4

      • remove

        public void remove​(StringSE name)
        この ParameterList から指定されたパラメーターを削除します。パラメーターが存在しない場合、このメソッドは何もしません。
        パラメーター:
        name - パラメーターの名前。

      • getNames

        public EnumerationSE<StringSE> getNames()
        このリスト内のすべてのパラメーターの名前の列挙を返します。
        戻り値:
        このリスト内のすべてのパラメーター名の列挙。

      • toString

        public StringSE toString()
        この ParameterList を MIME 文字列に変換します。これが空のリストの場合、空の文字列が返されます。
        オーバーライド:
        クラス ObjectSE の toString 
        戻り値:
        String

      • toString

        public StringSE toString​(int used)
        この ParameterList を MIME 文字列に変換します。これが空のリストの場合、空の文字列が返されます。'used' パラメーターは、結果のパラメーターリストが挿入されるフィールドですでに使用されている文字位置の数を指定します。結果のパラメーターリストを折りたたむ場所を決定するために使用されます。
        パラメーター:
        used - パラメーターリストが挿入されるフィールドで、すでに使用されている文字位置の数。
        戻り値:
        String