Toruca (DoJa-5.1 (APIリファレンス))

トルカデータを定義します。

トルカ機能では、トルカデータの登録や取得を行うクラスとトルカデータそのものを表すクラスが区別されています。このクラスはトルカデータそのものを表しますが、トルカデータの登録や取得はTorucaStoreクラスで行います。

トルカデータを新規に作成し、登録するためには、コンストラクタにより Toruca オブジェクトを生成します。生成したオブジェクトに対してデータ１等の設定、取得、および TorucaStore.addEntry(Toruca) メソッドによる登録を行うことができます。登録の成否にかかわらず、登録に使用した Toruca オブジェクトの状態は変化しません。

[DoJa-4.1 (902iS) まで]
なお、トルカデータのURL、データ１、データ２、データ３の文字列の合計サイズは 0byte より大きくなければなりませんが、このクラスではこの合計サイズのチェックは行いません。この合計サイズのチェックは登録時（TorucaStore.addEntry(Toruca)）に行われます。
[DoJa-5.0 (903i) 以降]
トルカデータのURL、データ１、データ２、データ３の合計サイズのチェックはこのクラスでは行いません。また、登録時（TorucaStore.addEntry(Toruca)）にも行いません。よって、トルカデータのURL、データ１、データ２、データ３の文字列の合計サイズが 0byte のトルカデータについても登録可能です。

また、トルカデータの全体サイズは、トルカスニップとして登録する場合は 1Kbyte 以下、トルカカードとして登録する場合は 100Kbyte 以下(ヘッダ部とスニップデータ部の合計サイズは 1Kbyte 以下)でなければなりませんが、このクラスでは全体サイズのチェックは行いません。トルカデータの全体サイズのチェックは、登録時（TorucaStore.addEntry(Toruca)）に行われます。ただし、トルカデータに設定できる残りバイト数は TorucaStore.getRemainingBytes(Toruca) メソッドによって調べることができます。

以下のメソッド・コンストラクタ呼び出しにおいて、トルカオブジェクト生成の元となったトルカデータに不正な値が含まれていた場合、その値を取得するメソッドによって返される値は、機種依存となります。

トルカデータの各要素を取得するメソッドの説明において、「設定されていない場合」とは、構成要素の値が null である場合、または要素自体がない場合とします。

フィールドの概要
`static String`	`TYPE_CARD` トルカ種別の一つで、トルカカードのことを表します (="card")。
`static String`	`TYPE_SNIP` トルカ種別の一つで、トルカスニップのことを表します (="snip")。

コンストラクタの概要
`Toruca()` トルカデータを生成します。
`Toruca(byte[] data)` トルカデータを生成します。

メソッドの概要
`byte[]`	`getBody()` トルカカードの本体部を取得します。
`byte[]`	`getCategory()` カテゴリを取得します。
`int`	`getColorID()` 色IDを取得します。
`String`	`getData1()` データ１を取得します。
`String`	`getData2()` データ２を取得します。
`String`	`getData3()` データ３を取得します。
`java.util.Date`	`getExpirationDate()` このトルカデータの有効期限を取得します。
`String`	`getIPID()` コンテンツ開発者が独自で指定しているID( IP-ID )を取得します。
`String`	`getProperty(String key)` 指定されたキーに該当するプロパティ値を取得します。
`int`	`getRedistributionID()` このトルカデータの再配布識別子を取得します。
`String`	`getSortID()` トルカデータのソートに用いるための読み仮名(カナID)を取得します。
`String`	`getType()` トルカ種別を取得します。
`String`	`getURL()` トルカカードの取得先URLを取得します。
`byte[]`	`getVersion()` トルカデータのバージョンを取得します。
`void`	`setBody(byte[] body)` トルカカードの本体部を設定します。
`void`	`setCategory(byte[] code)` カテゴリを設定します。
`void`	`setData1(String data1)` データ１を設定します。
`void`	`setData2(String data2)` データ２を設定します。
`void`	`setData3(String data3)` データ３を設定します。
`void`	`setProperty(String key, String value)` 指定されたキーに該当するプロパティ値を設定します。
`void`	`setType(String type)` トルカ種別を設定します。
`void`	`setURL(String url)` トルカカードの取得先URLを設定します。
`void`	`setVersion(byte[] version)` トルカデータのバージョンを設定します。

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

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

com.nttdocomo.system クラス Toruca

TYPE_CARD

TYPE_SNIP

Toruca

Toruca

com.nttdocomo.system
クラス Toruca