javax.mail.internet
クラス ParameterList

java.lang.Object
  上位を拡張 javax.mail.internet.ParameterList

public final class ParameterList
extends Object

このクラスは MIME パラメータ (属性と値の対) を保持します。


コンストラクタの概要
ParameterList()
          引数なしのコンストラクタです。
ParameterList(String s)
          パラメータリスト文字列を使用するコンストラクタです。
 
メソッドの概要
 String get(String name)
          指定されたパラメータの値を返します。
 Enumeration getNames()
          このリスト内の全パラメータの名前の列挙を返します。
 void remove(String name)
          指定されたパラメータをこの ParameterList から削除します。
 void set(String name, String value)
          パラメータを設定します。
 void set(String name, String value, String charset)
          パラメータを設定します。
 int size()
          このリスト内にあるパラメータの数を返します。
 String toString()
          この ParameterList を MIME String に変換します。
 String toString(int used)
          この ParameterList を MIME String に変換します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

ParameterList

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


ParameterList

public ParameterList(String s)
              throws ParseException
パラメータリスト文字列を使用するコンストラクタです。 String の構文解析とパラメータの収集及び格納は内部的に行われます。 構文解析に失敗すると ParseException がスローされます。 空のパラメータリスト文字列は有効であり、空の ParameterList に構文解析される事に注意して下さい。

パラメータ:
s - パラメータリスト文字列
例外:
ParseException - 構文解析に失敗した場合
メソッドの詳細

size

public int size()
このリスト内にあるパラメータの数を返します。

戻り値:
パラメータの数

get

public String get(String name)
指定されたパラメータの値を返します。 パラメータ名は大文字と小文字を区別しない事に注意して下さい。

パラメータ:
name - パラメータ名
戻り値:
パラメータの値。パラメータが存在しない場合は null を返します。

set

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

パラメータ:
name - パラメータの名前
value - パラメータの値

set

public void set(String name,
                String value,
                String charset)
パラメータを設定します。このパラメータが既に存在する場合、この新しい値で置き換えられます。 If the mail.mime.encodeparameters System property is true, and the parameter value is non-ASCII, it will be encoded with the specified charset, as specified by RFC 2231.

パラメータ:
name - パラメータの名前
value - パラメータの値
charset - charset of the parameter value.
導入されたバージョン:
JavaMail 1.4

remove

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

パラメータ:
name - パラメータの名前

getNames

public Enumeration getNames()
このリスト内の全パラメータの名前の列挙を返します。

戻り値:
このリスト内の全パラメータ名の列挙

toString

public String toString()
この ParameterList を MIME String に変換します。 これが空のリストの場合、空の文字列が返されます。

オーバーライド:
クラス Object 内の toString
戻り値:
String

toString

public String toString(int used)
この ParameterList を MIME String に変換します。 これが空のリストの場合、空の文字列が返されます。 'used' パラメータは、結果のパラメータリストが挿入されるフィールドにおいて、 既に占有されている文字位置の数を指定します。 結果のパラメータリストを挿入する場所を識別する為に使用されます。

パラメータ:
used - パラメータリストが挿入されるフィールドで既に使用されている文字位置の数
戻り値:
String