com.nttdocomo.system
クラス PhoneBookParam

Object
  com.nttdocomo.system.PhoneBookParam

すべての実装インタフェース:

PhoneBookConstants

public final class PhoneBookParam

extends Object

implements PhoneBookConstants

電話帳データの新規登録用のパラメータを定義します。

電話帳データを新規に登録するためには、 コンストラクタによりPhoneBookParamオブジェクトを生成します。 生成したオブジェクトに対して名前等を通常の文字列で設定することができます。 電話帳グループについてはエントリ ID または名前を設定することができますが、 それらは排他的に設定されます。 すなわち、 電話帳グループのエントリ ID を指定した場合には既に設定されていた電話帳グループ名は破棄されます。 なお、各メソッドの引数に設定する文字列の扱いは、PhoneBook クラスの addEntry() に設定する文字列の扱いと同様です。

登録は PhoneBook.addEntry(PhoneBookParam) メソッドで行います。 登録時の動作の詳細は、メソッドの説明を参照して下さい。

名前や読み仮名は、 姓と名を区別して登録する方法 (setName(int, String) および setKana(int, String))と、 区別しないで登録する方法 (setName(String) および setKana(String))があります。 これらは(名前と読み仮名に対して独立に)排他的に使用され、 一方の方法で指定した内容は、他方の方法で指定すると破棄されます。

導入されたバージョン:

DoJa-3.0 (505i)

関連項目:

PhoneBook

フィールドの概要

インタフェース com.nttdocomo.system.PhoneBookConstants から継承したフィールド

FAMILY_NAME, GIVEN_NAME

コンストラクタの概要

PhoneBookParam()
新規登録用に電話帳パラメータを生成します。

PhoneBookParam(String name, String kana, String[] phoneNumbers, String[] mailAddresses, int groupId)
新規登録用に電話帳パラメータを生成します。

PhoneBookParam(String name, String kana, String[] phoneNumbers, String[] mailAddresses, String groupName)
新規登録用に電話帳パラメータを生成します。

メソッドの概要

void	addMailAddress(String mailAddress) 電話帳パラメータにメールアドレス(通常文字列)を追加します。
void	addPhoneNumber(String phoneNumber) 電話帳パラメータに電話番号(通常文字列)を追加します。
int	getGroupId() 電話帳グループのエントリ ID を取得します。
String	getGroupName() 電話帳グループ名を取得します。
String	getKana() 読み仮名(通常文字列)を取得します。
String	getKana(int part) 姓または名の読み仮名(通常文字列)を取得します。
Location	getLocation() [iアプリオプションAPI] 位置情報を取得します。
String	getMailAddress(int index) メールアドレス(通常文字列)の1つを取得します。
String[]	getMailAddresses() メールアドレス(通常文字列)を取得します。
String	getName() 名前(通常文字列)を取得します。
String	getName(int part) 姓または名(通常文字列)を取得します。
String	getPhoneNumber(int index) 電話番号(通常文字列)の1つを取得します。
String[]	getPhoneNumbers() 電話番号(通常文字列)を取得します。
void	setGroupId(int id) 電話帳グループのエントリ ID を設定します。
void	setGroupName(String name) 電話帳グループ名を設定します。
void	setKana(int part, String name) 姓または名の読み仮名(通常文字列)を設定します。
void	setKana(String kana) 読み仮名(通常文字列)を設定します。
void	setLocation(Location location) [iアプリオプションAPI] 位置情報を設定します。
void	setMailAddresses(String[] mailAddresses) メールアドレス(通常文字列)を設定します。
void	setName(int part, String name) 姓または名(通常文字列)を設定します。
void	setName(String name) 名前(通常文字列)を設定します。
void	setPhoneNumbers(String[] phoneNumbers) 電話番号(通常文字列)を設定します。

クラス Object から継承したメソッド

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

コンストラクタの詳細

PhoneBookParam

public PhoneBookParam()

新規登録用に電話帳パラメータを生成します。
PhoneBookParam(null, null, null, null, -1)と同じです。

PhoneBookParam

public PhoneBookParam(String name,
                      String kana,
                      String[] phoneNumbers,
                      String[] mailAddresses,
                      String groupName)

新規登録用に電話帳パラメータを生成します。 パラメータは引数で指定される内容で初期化されます。 各引数に指定できる文字列については、 PhoneBook.addEntry(String, String, String[], String[], String) 時に設定する文字列の扱いと同様です。

FOMA 端末において、 位置情報は null で初期化されます。 位置情報はオブジェクト生成後に setLocation(Location) メソッドにて設定して下さい。

パラメータ:

name - 名前(通常文字列)を指定します。 姓と名が区別可能な場合、 setName(String) メソッドを呼び出した場合と同じように動作します。

kana - 読み仮名(通常文字列)を指定します。 姓と名が区別可能な場合、 setKana(String) メソッドを呼び出した場合と同じように動作します。

phoneNumbers - 電話番号(通常文字列)を配列で指定します。

mailAddresses - メールアドレス(通常文字列)を配列で指定します。

groupName - 電話帳グループ名を指定します。 電話帳グループを指定しない場合には、 null を指定します。

例外:

NullPointerException - phoneNumbers、mailAddressesがそれぞれnullで無い場合に、 配列の要素にnullが含まれている場合に発生します。

IllegalArgumentException - 電話番号として登録できない文字列が指定された場合、 実装がサポートしている長さ以上の電話番号が指定された場合、 実装がサポートしている数以上の電話番号が指定された場合に発生します。

IllegalArgumentException - メールアドレスとして登録できない文字列が指定された場合、 実装がサポートしている長さ以上のメールアドレスが指定された場合、 実装がサポートしている数以上のメールアドレスが指定された場合に発生します。

PhoneBookParam

public PhoneBookParam(String name,
                      String kana,
                      String[] phoneNumbers,
                      String[] mailAddresses,
                      int groupId)

新規登録用に電話帳パラメータを生成します。 パラメータは引数で指定される内容で初期化されます。 各引数に指定できる文字列については、 PhoneBook.addEntry(String, String, String[], String[], int) 時に設定する文字列の扱いと同様です。

FOMA 端末において、 位置情報は null で初期化されます。 位置情報はオブジェクト生成後に setLocation(Location) メソッドにて設定して下さい。

パラメータ:

name - 名前(通常文字列)を指定します。 姓と名が区別可能な場合、 setName(String) メソッドを呼び出した場合と同じように動作します。

kana - 読み仮名(通常文字列)を指定します。 姓と名が区別可能な場合、 setKana(String) メソッドを呼び出した場合と同じように動作します。

phoneNumbers - 電話番号(通常文字列)を配列で指定します。

mailAddresses - メールアドレス(通常文字列)を配列で指定します。

groupId - 電話帳グループのエントリ IDを指定します。 電話帳グループを指定しない場合には、 -1 を指定します。

例外:

NullPointerException - phoneNumbers、mailAddressesがそれぞれnullで無い場合に、 配列の要素にnullが含まれている場合に発生します。

IllegalArgumentException - 電話番号として登録できない文字列が指定された場合、 実装がサポートしている長さ以上の電話番号が指定された場合、 実装がサポートしている数以上の電話番号が指定された場合に発生します。

IllegalArgumentException - メールアドレスとして登録できない文字列が指定された場合、 実装がサポートしている長さ以上のメールアドレスが指定された場合、 実装がサポートしている数以上のメールアドレスが指定された場合に発生します。

メソッドの詳細

getName

public String getName()

名前(通常文字列)を取得します。
setName(String) メソッドまたはコンストラクタで設定した内容を返します。

戻り値:

名前を返します。 設定されていない場合、nullを返します。

setName

public void setName(String name)

名前(通常文字列)を設定します。
このメソッドを呼び出すと、 以前にsetName(int, String) メソッドで設定した内容は破棄されます。

引数に指定できる文字列については、 PhoneBook.addEntry() 時に設定する名前の文字列の扱いと同様です。

パラメータ:

name - 名前を指定します。 nullを指定すると名前が削除されます。

getName

public String getName(int part)

姓または名(通常文字列)を取得します。
setName(int, String) メソッドで設定した内容を返します。

パラメータ:

part - 姓、名の区別を指定します。 FAMILY_NAME、 GIVEN_NAME のいずれかを指定します。

戻り値:

名前を返します。 設定されていない場合、nullを返します。

例外:

IllegalArgumentException - 引数 part の値が不正な場合に発生します。

setName

public void setName(int part,
                    String name)

姓または名(通常文字列)を設定します。
このメソッドを呼び出すと、 以前にsetName(String) メソッドで設定した内容は破棄されます。

引数に指定できる文字列については、 PhoneBook.addEntry() 時に設定する名前の文字列の扱いと同様です。

パラメータ:

part - 姓、名の区別を指定します。 FAMILY_NAME、 GIVEN_NAME のいずれかを指定します。

name - 名前を指定します。 nullを指定すると名前が削除されます。

例外:

IllegalArgumentException - 引数 part の値が不正な場合に発生します。

getKana

public String getKana()

読み仮名(通常文字列)を取得します。
setKana(String) メソッドまたはコンストラクタで設定した内容を返します。

戻り値:

読み仮名を返します。 設定されていない場合、nullを返します。

setKana

public void setKana(String kana)

読み仮名(通常文字列)を設定します。
このメソッドを呼び出すと、 以前にsetKana(int, String) メソッドで設定した内容は破棄されます。

引数に指定できる文字列については、 PhoneBook.addEntry() 時に設定する読み仮名の文字列の扱いと同様です。

パラメータ:

kana - 読み仮名を指定します。 nullを指定すると読み仮名が削除されます。

getKana

public String getKana(int part)

姓または名の読み仮名(通常文字列)を取得します。
setKana(int, String) メソッドで設定した内容を返します。

パラメータ:

part - 姓、名の区別を指定します。 FAMILY_NAME、 GIVEN_NAME のいずれかを指定します。

戻り値:

読み仮名を返します。 設定されていない場合、nullを返します。

例外:

IllegalArgumentException - 引数 part の値が不正な場合に発生します。

setKana

public void setKana(int part,
                    String name)

姓または名の読み仮名(通常文字列)を設定します。
このメソッドを呼び出すと、 以前にsetKana(String) メソッドで設定した内容は破棄されます。

引数に指定できる文字列については、 PhoneBook.addEntry() 時に設定する読み仮名の文字列の扱いと同様です。

パラメータ:

part - 姓、名の区別を指定します。 FAMILY_NAME、 GIVEN_NAME のいずれかを指定します。

name - 読み仮名を指定します。 nullを指定すると読み仮名が削除されます。

例外:

IllegalArgumentException - 引数 part の値が不正な場合に発生します。

getPhoneNumbers

public String[] getPhoneNumbers()

電話番号(通常文字列)を取得します。

戻り値:

設定されているすべての電話番号を配列で返します。 設定されていない場合、nullを返します。 返される配列は、このオブジェクトが内部で保持している配列のコピーです。

getPhoneNumber

public String getPhoneNumber(int index)

電話番号(通常文字列)の1つを取得します。
getPhoneNumbers()[index] と同じ値が返ります。

パラメータ:

index - 電話番号のインデックスを指定します。

戻り値:

指定されたインデックスの電話番号(通常文字列)を返します。

例外:

ArrayIndexOutOfBoundsException - 指定されたインデックスの電話番号が存在しない場合に発生します。

setPhoneNumbers

public void setPhoneNumbers(String[] phoneNumbers)

電話番号(通常文字列)を設定します。

引数に指定できる値については、 PhoneBook.addEntry() 時に設定する電話番号の配列の扱いと同様です。

パラメータ:

phoneNumbers - 電話番号を配列で指定します。 nullや長さ0の配列を指定すると電話番号が削除されます。

例外:

NullPointerException - phoneNumbersがnullで無い場合に、 配列の要素にnullが含まれていた場合に発生します。

IllegalArgumentException - 実装がサポートしている数以上の電話番号が指定された場合に発生します。

IllegalArgumentException - 電話番号として登録できない文字列が指定された場合に発生します。

IllegalArgumentException - 実装がサポートしている長さ以上の電話番号が指定された場合に発生します。

addPhoneNumber

public void addPhoneNumber(String phoneNumber)

電話帳パラメータに電話番号(通常文字列)を追加します。 引数に指定できる値については、 PhoneBook.addEntry() 時に設定する電話番号の配列の各要素の扱いと同様です。

パラメータ:

phoneNumber - 追加する電話番号を指定します。

例外:

IllegalStateException - 実装がサポートしている最大数の電話番号が既に設定されている場合に発生します。

NullPointerException - phoneNumberがnullの場合に発生します。

IllegalArgumentException - 電話番号として登録できない文字列が指定された場合に発生します。

IllegalArgumentException - 実装がサポートしている長さ以上の電話番号が指定された場合に発生します。

getMailAddresses

public String[] getMailAddresses()

メールアドレス(通常文字列)を取得します。 引数に指定できる値については、 PhoneBook.addEntry() 時に設定するメールアドレスの配列の各要素の扱いと同様です。

戻り値:

設定されているすべてのメールアドレス(通常文字列)を配列で返します。 設定されていない場合、nullを返します。 返される配列は、このオブジェクトが内部で保持している配列のコピーです。

getMailAddress

public String getMailAddress(int index)

メールアドレス(通常文字列)の1つを取得します。
getMailAddresses()[index] と同じ値が返ります。

パラメータ:

index - メールアドレスのインデックスを指定します。

戻り値:

指定されたインデックスのメールアドレス(通常文字列)を返します。

例外:

ArrayIndexOutOfBoundsException - 指定されたインデックスのメールアドレスが存在しない場合に発生します。

setMailAddresses

public void setMailAddresses(String[] mailAddresses)

メールアドレス(通常文字列)を設定します。

引数に指定できる値については、 PhoneBook.addEntry() 時に設定するメールアドレスの配列の扱いと同様です。

パラメータ:

mailAddresses - メールアドレスを配列で指定します。 nullや長さ0の配列を指定するとメールアドレスが削除されます。

例外:

NullPointerException - mailAddressesがnullで無い場合に、 配列の要素にnullが含まれていた場合に発生します。

IllegalArgumentException - 実装がサポートしている数以上のメールアドレスが指定された場合に発生します。

IllegalArgumentException - メールアドレスとして登録できない文字列が指定された場合に発生します。

IllegalArgumentException - 実装がサポートしている長さ以上のメールアドレスが指定された場合に発生します。

addMailAddress

public void addMailAddress(String mailAddress)

電話帳パラメータにメールアドレス(通常文字列)を追加します。

パラメータ:

mailAddress - 追加するメールアドレスを指定します。

例外:

IllegalStateException - 実装がサポートしている最大数のメールアドレスが既に設定されている場合に発生します。

NullPointerException - mailAddressがnullの場合に発生します。

IllegalArgumentException - メールアドレスとして登録できない文字列が指定された場合に発生します。

IllegalArgumentException - 実装がサポートしている長さ以上のメールアドレスが指定された場合に発生します。

getGroupId

public int getGroupId()

電話帳グループのエントリ ID を取得します。

戻り値:

電話帳グループのエントリ ID を返します。 電話帳グループが設定されていない場合、 電話帳グループ名が設定されている場合は、 -1を返します。

setGroupId

public void setGroupId(int id)

電話帳グループのエントリ ID を設定します。
以前に電話帳グループ名が設定されている場合は、 電話帳グループ名が無効になります。

引数に指定できる値については、 PhoneBook.addEntry(String, String, String[], String[], int) 時に設定する電話帳グループのエントリ ID の扱いと同様です。

パラメータ:

id - グループIDを指定します。

getGroupName

public String getGroupName()

電話帳グループ名を取得します。

戻り値:

電話帳グループ名を返します。 電話帳グループが設定されていない場合、 電話帳グループのエントリ ID が設定されている場合は、 nullを返します。

setGroupName

public void setGroupName(String name)

電話帳グループ名を設定します。
以前に電話帳グループのエントリ ID が設定されている場合は電話帳グループのエントリ ID が無効になります。

引数に指定できる文字列については、 PhoneBook.addEntry(String, String, String[], String[], String) 時に設定する電話帳グループ名の文字列の扱いと同様です。

パラメータ:

name - 電話帳グループ名を指定します。

setLocation

public void setLocation(Location location) [iアプリオプションAPI]

位置情報を設定します。 null を指定すると、既に設定されていた位置情報がクリアされます。

このオブジェクトは、引数に指定された Location オブジェクトをコピーして保持します。

電話帳エントリにおいて位置情報をサポートしていない実装でも、 メソッドは正常に動作します (このオブジェクトを登録する時に位置情報のみ無視されます)。

パラメータ:

location - 位置情報を指定します。

導入されたバージョン:

DoJa-4.0LE, DoJa-5.0 (903i)

getLocation

public Location getLocation() [iアプリオプションAPI]

位置情報を取得します。 位置情報として何も設定されていない場合には null を返します。

電話帳エントリにおいて位置情報をサポートしていない実装でも、 メソッドは正常に動作します。 すなわち、setLocation() メソッドで設定された位置情報オブジェクトのコピーが返されます。

戻り値:

位置情報を返します。 返される位置情報オブジェクトは、 このオブジェクトが保持している Location オブジェクトのコピーです。

導入されたバージョン:

DoJa-4.0LE, DoJa-5.0 (903i)